Add support for documentation strings

Author: srydell

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.15...3.16)
 
 project(
   IR
-  VERSION 0.11.0
+  VERSION 0.12.0
   LANGUAGES CXX)
 
 configure_file(docs/ReleaseNotes/version.in

docs/ReleaseNotes/v0.12.0.md

@@ -0,0 +1,9 @@
+# News #
+
+## Features ##
+
+* Support for documentation strings in:
+  * Enum
+  * Variable
+  * Function
+  * Struct

include/IR/ir.hpp

@@ -71,6 +71,8 @@ struct Enum {
 	std::string m_name;
 	// Fully qualified name
 	std::string m_representation;
+	// Documentation string
+	std::string m_documentation;
 	// Unscoped values
 	std::vector<std::string> m_values;
 	// True if it was declared as 'enum class'
@@ -101,7 +103,7 @@ struct Type {
 		// Fully qualified name of the function
 		std::string m_representation;
 	};
-	
+
 	// Represents a type parameter that is an integral
 	// E.g. 3 in std::array<int, 3>
 	struct Integral {};
@@ -134,6 +136,8 @@ struct Type {
 struct Variable {
 	// Name that should be used to access the variable
 	std::string m_name;
+	// Documentation string
+	std::string m_documentation;
 
 	Type m_type;
 };
@@ -146,6 +150,9 @@ struct Function {
 	// E.g. MyNamespace::myFunction
 	std::string m_representation;
 
+	// Documentation string
+	std::string m_documentation;
+
 	Type m_returnType;
 
 	std::vector<Variable> m_arguments;
@@ -174,6 +181,9 @@ struct Struct {
 	// E.g. MyNamespace::MyClass
 	std::string m_representation;
 
+	// Documentation string
+	std::string m_documentation;
+
 	StructData m_public;
 	StructData m_private;
 	StructData m_protected;