diff --git a/src/Generator/Generators/CLI/CLIGenerator.cs b/src/Generator/Generators/CLI/CLIGenerator.cs
index 6819acbc..e259efc4 100644
--- a/src/Generator/Generators/CLI/CLIGenerator.cs
+++ b/src/Generator/Generators/CLI/CLIGenerator.cs
@@ -4,6 +4,10 @@ using CppSharp.Types.Std;
namespace CppSharp.Generators.CLI
{
+ ///
+ /// C++/CLI generator responsible for driving the generation of
+ /// source and header files.
+ ///
public class CLIGenerator : Generator
{
private readonly CLITypePrinter typePrinter;
@@ -14,6 +18,9 @@ namespace CppSharp.Generators.CLI
Type.TypePrinterDelegate += type => type.Visit(typePrinter);
}
+ ///
+ /// Generates the code for a given translation unit.
+ ///
public override bool Generate(TranslationUnit unit,
List outputs)
{
diff --git a/src/Generator/Generators/CLI/CLIHeadersTemplate.cs b/src/Generator/Generators/CLI/CLIHeadersTemplate.cs
index 479934e2..5c9e328e 100644
--- a/src/Generator/Generators/CLI/CLIHeadersTemplate.cs
+++ b/src/Generator/Generators/CLI/CLIHeadersTemplate.cs
@@ -6,6 +6,9 @@ using CppSharp.Types;
namespace CppSharp.Generators.CLI
{
+ ///
+ /// Generates C++/CLI header files.
+ ///
public class CLIHeadersTemplate : CLITextTemplate
{
public override string FileExtension { get { return "h"; } }
diff --git a/src/Generator/Generators/CLI/CLISourcesTemplate.cs b/src/Generator/Generators/CLI/CLISourcesTemplate.cs
index db5208cc..c613be77 100644
--- a/src/Generator/Generators/CLI/CLISourcesTemplate.cs
+++ b/src/Generator/Generators/CLI/CLISourcesTemplate.cs
@@ -7,6 +7,9 @@ using CppSharp.Types;
namespace CppSharp.Generators.CLI
{
+ ///
+ /// Generates C++/CLI source files.
+ ///
public class CLISourcesTemplate : CLITextTemplate
{
public CLISourcesTemplate(Driver driver, TranslationUnit unit)
diff --git a/src/Generator/Generators/CLI/CLITextTemplate.cs b/src/Generator/Generators/CLI/CLITextTemplate.cs
index c8171490..6041cd6c 100644
--- a/src/Generator/Generators/CLI/CLITextTemplate.cs
+++ b/src/Generator/Generators/CLI/CLITextTemplate.cs
@@ -22,6 +22,11 @@ namespace CppSharp.Generators.CLI
}
}
+ ///
+ /// There are two implementation
+ /// for source (CLISourcesTemplate) and header (CLIHeadersTemplate)
+ /// files.
+ ///
public abstract class CLITextTemplate : TextTemplate
{
protected const string DefaultIndent = " ";
diff --git a/src/Generator/Generators/Generator.cs b/src/Generator/Generators/Generator.cs
index bebb6f56..33342d54 100644
--- a/src/Generator/Generators/Generator.cs
+++ b/src/Generator/Generators/Generator.cs
@@ -3,6 +3,9 @@ using System.IO;
namespace CppSharp.Generators
{
+ ///
+ /// Kinds of language generators.
+ ///
public enum LanguageGeneratorKind
{
CPlusPlusCLI,
@@ -30,6 +33,9 @@ namespace CppSharp.Generators
public string OutputPath;
}
+ ///
+ /// Generators are the base class for each language backend.
+ ///
public abstract class Generator
{
public Driver Driver { get; private set; }
@@ -39,6 +45,9 @@ namespace CppSharp.Generators
Driver = driver;
}
+ ///
+ /// Generates the code for a given translation unit.
+ ///
public abstract bool Generate(TranslationUnit unit,
List outputs);