ConForM.CoopnTools.CoKer.DocComment
Class DocCommentParser

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.DocComment.DocCommentParser

public class DocCommentParser
extends java.lang.Object

Documentation Comments Parser. This class essentially defines the services allowing to parse documentation comments.


Field Summary
static java.lang.String VERSION
          Coopn source Manager version;
 
Constructor Summary
DocCommentParser(CoopnEnv env)
          Constructor.
 
Method Summary
 DocComment parseModuleComment(CoopnSyntacticModule module)
          Parse the comment of a syntactic module.
 DocComment parseSymbolComment(CoopnSyntacticSymbol symbol)
          Parse the comment of a syntactic symbol Valid comments are see (in any case), param (in case of CoopnSyntacticParamSymbol, CoopnSyntacicRelationnalSymbol, and CoopnSyntacticFunctionnalSymbol), and return (in case of CoopnSyntacticFunctionnalSymbol).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERSION

public static final java.lang.String VERSION
Coopn source Manager version;
Constructor Detail

DocCommentParser

public DocCommentParser(CoopnEnv env)
                 throws java.lang.IllegalArgumentException
Constructor. Build a new doc comment parser.
Parameters:
env - the environment of the project manager
Throws:
java.lang.IllegalArgumentException - the environment is absent or inconsistent.
Method Detail

parseModuleComment

public DocComment parseModuleComment(CoopnSyntacticModule module)
Parse the comment of a syntactic module. Valid tags are see, author and version.
Parameters:
module - the syntactic module
Returns:
the comment associated to the module, if it exists and is valid, or null in the other cases.

parseSymbolComment

public DocComment parseSymbolComment(CoopnSyntacticSymbol symbol)
Parse the comment of a syntactic symbol Valid comments are see (in any case), param (in case of CoopnSyntacticParamSymbol, CoopnSyntacicRelationnalSymbol, and CoopnSyntacticFunctionnalSymbol), and return (in case of CoopnSyntacticFunctionnalSymbol).
Parameters:
symbol - the syntactic symbol
Returns:
the comment associated to the symbol, if it exists and is valid, or null in the other cases.