From 8aede6b08a839d3ee12fde9fd5fba454701a14e4 Mon Sep 17 00:00:00 2001 From: krasimir Date: Wed, 31 May 2017 19:01:04 +0000 Subject: [PATCH] a bit more documentation copied from Java --- src/runtime/dotNet/Bracket.cs | 5 ++++- src/runtime/dotNet/Concr.cs | 2 +- src/runtime/dotNet/Expr.cs | 3 +++ src/runtime/dotNet/PGF.cs | 2 +- src/runtime/dotNet/Type.cs | 2 +- 5 files changed, 10 insertions(+), 4 deletions(-) diff --git a/src/runtime/dotNet/Bracket.cs b/src/runtime/dotNet/Bracket.cs index fa9c77d74..8fa005704 100644 --- a/src/runtime/dotNet/Bracket.cs +++ b/src/runtime/dotNet/Bracket.cs @@ -16,7 +16,10 @@ namespace PGFSharp Bracket AsBracketChild {get;} } - + /// + /// A representation for a syntactic constituent in the parse tree + /// of a sentence. + /// public class Bracket : IBracketChild { public class StringChildBracket : IBracketChild { diff --git a/src/runtime/dotNet/Concr.cs b/src/runtime/dotNet/Concr.cs index cbb4c6d51..c8d179d7f 100644 --- a/src/runtime/dotNet/Concr.cs +++ b/src/runtime/dotNet/Concr.cs @@ -8,7 +8,7 @@ using System.Runtime.InteropServices; namespace PGFSharp { /// - /// Concrete grammar. All concrete grammars are available from the (Abstract) class. + /// The class for concrete syntaxes. /// public class Concr { diff --git a/src/runtime/dotNet/Expr.cs b/src/runtime/dotNet/Expr.cs index a65b281bf..b5ab0b764 100644 --- a/src/runtime/dotNet/Expr.cs +++ b/src/runtime/dotNet/Expr.cs @@ -16,6 +16,9 @@ namespace PGFSharp } } + /// + /// A representation for an abstract syntax tree. + /// public abstract class Expr { internal IntPtr DataPtr => NativeGU.gu_variant_open(_ptr).Data; // PgfExprLit* diff --git a/src/runtime/dotNet/PGF.cs b/src/runtime/dotNet/PGF.cs index 0d2f1d251..5abfbe91c 100644 --- a/src/runtime/dotNet/PGF.cs +++ b/src/runtime/dotNet/PGF.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace PGFSharp { /// - /// This is the class for PGF grammars. + /// The class for PGF grammars. /// public class PGF { diff --git a/src/runtime/dotNet/Type.cs b/src/runtime/dotNet/Type.cs index 9ec2c45d8..f9392bdf7 100644 --- a/src/runtime/dotNet/Type.cs +++ b/src/runtime/dotNet/Type.cs @@ -8,7 +8,7 @@ using System.Threading.Tasks; namespace PGFSharp { /// - /// A GF type. + /// A class for types in the abstract syntax of a grammar. /// public class Type {