Browse Source

Added some documentation to some classes.

pull/3/head
triton 12 years ago
parent
commit
c8ce6ad245
  1. 7
      src/Generator/Generators/CLI/CLIGenerator.cs
  2. 3
      src/Generator/Generators/CLI/CLIHeadersTemplate.cs
  3. 3
      src/Generator/Generators/CLI/CLISourcesTemplate.cs
  4. 5
      src/Generator/Generators/CLI/CLITextTemplate.cs
  5. 9
      src/Generator/Generators/Generator.cs

7
src/Generator/Generators/CLI/CLIGenerator.cs

@ -4,6 +4,10 @@ using CppSharp.Types.Std;
namespace CppSharp.Generators.CLI namespace CppSharp.Generators.CLI
{ {
/// <summary>
/// C++/CLI generator responsible for driving the generation of
/// source and header files.
/// </summary>
public class CLIGenerator : Generator public class CLIGenerator : Generator
{ {
private readonly CLITypePrinter typePrinter; private readonly CLITypePrinter typePrinter;
@ -14,6 +18,9 @@ namespace CppSharp.Generators.CLI
Type.TypePrinterDelegate += type => type.Visit(typePrinter); Type.TypePrinterDelegate += type => type.Visit(typePrinter);
} }
/// <summary>
/// Generates the code for a given translation unit.
/// </summary>
public override bool Generate(TranslationUnit unit, public override bool Generate(TranslationUnit unit,
List<GeneratorOutput> outputs) List<GeneratorOutput> outputs)
{ {

3
src/Generator/Generators/CLI/CLIHeadersTemplate.cs

@ -6,6 +6,9 @@ using CppSharp.Types;
namespace CppSharp.Generators.CLI namespace CppSharp.Generators.CLI
{ {
/// <summary>
/// Generates C++/CLI header files.
/// </summary>
public class CLIHeadersTemplate : CLITextTemplate public class CLIHeadersTemplate : CLITextTemplate
{ {
public override string FileExtension { get { return "h"; } } public override string FileExtension { get { return "h"; } }

3
src/Generator/Generators/CLI/CLISourcesTemplate.cs

@ -7,6 +7,9 @@ using CppSharp.Types;
namespace CppSharp.Generators.CLI namespace CppSharp.Generators.CLI
{ {
/// <summary>
/// Generates C++/CLI source files.
/// </summary>
public class CLISourcesTemplate : CLITextTemplate public class CLISourcesTemplate : CLITextTemplate
{ {
public CLISourcesTemplate(Driver driver, TranslationUnit unit) public CLISourcesTemplate(Driver driver, TranslationUnit unit)

5
src/Generator/Generators/CLI/CLITextTemplate.cs

@ -22,6 +22,11 @@ namespace CppSharp.Generators.CLI
} }
} }
/// <summary>
/// There are two implementation
/// for source (CLISourcesTemplate) and header (CLIHeadersTemplate)
/// files.
/// </summary>
public abstract class CLITextTemplate : TextTemplate public abstract class CLITextTemplate : TextTemplate
{ {
protected const string DefaultIndent = " "; protected const string DefaultIndent = " ";

9
src/Generator/Generators/Generator.cs

@ -3,6 +3,9 @@ using System.IO;
namespace CppSharp.Generators namespace CppSharp.Generators
{ {
/// <summary>
/// Kinds of language generators.
/// </summary>
public enum LanguageGeneratorKind public enum LanguageGeneratorKind
{ {
CPlusPlusCLI, CPlusPlusCLI,
@ -30,6 +33,9 @@ namespace CppSharp.Generators
public string OutputPath; public string OutputPath;
} }
/// <summary>
/// Generators are the base class for each language backend.
/// </summary>
public abstract class Generator public abstract class Generator
{ {
public Driver Driver { get; private set; } public Driver Driver { get; private set; }
@ -39,6 +45,9 @@ namespace CppSharp.Generators
Driver = driver; Driver = driver;
} }
/// <summary>
/// Generates the code for a given translation unit.
/// </summary>
public abstract bool Generate(TranslationUnit unit, public abstract bool Generate(TranslationUnit unit,
List<GeneratorOutput> outputs); List<GeneratorOutput> outputs);

Loading…
Cancel
Save