[Update] README

jsoysouvanh · Oct 29, 2021 · 5a37c50 · 5a37c50
1 parent fe13e0e
commit 5a37c50
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 731 deletions.
diff --git a/.github/workflows/build_and_tests.yml b/.github/workflows/build_and_tests.yml
@@ -118,7 +118,7 @@ jobs:
           mv Build/Release/Lib/libKodgen.a KodgenBinaries/Linux/Lib/
 
           mv Kodgen/Include KodgenBinaries/Include
-          mv Build/Release/Bin/KodgenSettings.toml KodgenBinaries/
+          mv Kodgen/KodgenSettings.toml KodgenBinaries/
          
           mv README.md KodgenBinaries/ 
           mv LICENSE.md KodgenBinaries/
@@ -171,7 +171,7 @@ jobs:
           mkdir KodgenBinaries/Mac/
           mkdir KodgenBinaries/Mac/Bin
           mkdir KodgenBinaries/Mac/Lib
-          mv Build/Release/Lib/libRefureku.a KodgenBinaries/Mac/Lib/
+          mv Build/Release/Lib/libKodgen.a KodgenBinaries/Mac/Lib/
           mv Kodgen/ThirdParty/x64/Shared/libclang.dylib KodgenBinaries/Mac/Bin/
 
       - name: Upload Binaries Artifact

diff --git a/Kodgen/Include/Kodgen/CodeGen/CodeGenModule.h b/Kodgen/Include/Kodgen/CodeGen/CodeGenModule.h
@@ -25,7 +25,7 @@ namespace kodgen
 	{
 		private:
 			/** Collection of all property code generators attached to this module. */
-			std::vector<PropertyCodeGen*>	_propertyCodeGenerators;
+			std::vector<PropertyCodeGen*> _propertyCodeGenerators;
 
 			/**
 			*	@brief	Call the visitor method with the provided entity/env pair.
@@ -37,8 +37,8 @@ namespace kodgen
 			* 
 			*	@return	The value returned from the visitor call.
 			*/
-			virtual ETraversalBehaviour	callVisitorOnEntity(EntityInfo const&									entity,
-															CodeGenEnv&											env,
+			virtual ETraversalBehaviour	callVisitorOnEntity(EntityInfo const&	entity,
+															CodeGenEnv&			env,
 															std::function<ETraversalBehaviour(ICodeGenerator&,
 																							  EntityInfo const&,
 																							  CodeGenEnv&,
@@ -66,14 +66,14 @@ namespace kodgen
 			* 
 			*	@param propertyCodeGen PropertyCodeGen to register.
 			*/
-			void										addPropertyCodeGen(PropertyCodeGen& propertyCodeGen)			noexcept;
+			void	addPropertyCodeGen(PropertyCodeGen& propertyCodeGen)			noexcept;
 
 			/**
 			*	@brief Remove a property code generator from this generation module.
 			* 
 			*	@param propertyCodeGen PropertyCodeGen to unregister.
 			*/
-			bool										removePropertyCodeGen(PropertyCodeGen const& propertyCodeGen)	noexcept;
+			bool	removePropertyCodeGen(PropertyCodeGen const& propertyCodeGen)	noexcept;
 
 		public:
 			/**
@@ -85,20 +85,20 @@ namespace kodgen
 			* 
 			*	@return true if the code generation completed successfully, else false. If false is returned
 			*/
-			virtual ETraversalBehaviour					generateCodeForEntity(EntityInfo const&	entity,
+			virtual ETraversalBehaviour				generateCodeForEntity(EntityInfo const&	entity,
 																			  CodeGenEnv&		env,
-																			  std::string&		inout_result)		noexcept = 0;
+																			  std::string&		inout_result)	noexcept = 0;
 
 			/**
 			*	@return The highest iteration count in all registered property code generators.
 			*/
-			virtual int32								getGenerationOrder()								const	noexcept	override;
+			virtual int32							getGenerationOrder()								const	noexcept override;
 
 			/**
 			*	@brief Getter for _propertyCodeGenerators field.
 			*
 			*	@return _propertyCodeGenerators.
 			*/
-			std::vector<PropertyCodeGen*> const&		getPropertyCodeGenerators()							const	noexcept;
+			std::vector<PropertyCodeGen*> const&	getPropertyCodeGenerators()							const	noexcept;
 	};
 }
diff --git a/Kodgen/KodgenSettings.toml b/Kodgen/KodgenSettings.toml
@@ -28,7 +28,6 @@ outputDirectory = '''Path/To/Output/Dir'''
 [ParsingSettings]
 # Include directories of the project
 projectIncludeDirectories = [
-#	'''Path/To/RefurekuLibrary/Include''',
 #	'''Path/To/Your/Project/Include'''
 ]