Package AdaDoc_Tree.Comment

AuthorJulien Burdy & Vincent Decorges
Date17.6.02
DescriptionAbstract machin to stock the comment
File nameadadoc_tree-comment.ads
 

Clauses

Quick access : ClausesGenericsDefinitionsSubprograms


 
Context clauses
Ada.Strings.Unbounded
Dict_TDA
 
Use clauses
Ada.Strings.Unbounded
 

Definitions

Quick access : ClausesGenericsDefinitionsSubprograms


Types
Name Declaration
Mode_Type(Before, After)
The comment could be before instruction or after
!!After is not yet implemented!!
 

Subprograms

Quick access : ClausesGenericsDefinitionsSubprograms


  
Init procedure
Purpose : Initalize the abstract machine

in : Mode : Functional mode of the abstract machine
when before : the comment are before the instruction
when after : the comment are after the instuction
in : Dict_Tag : Dictonary of possible tags in the header
in : Extract : Try to extract only the header if false
Parameter name Type Mode Default
ModeMode_TypeinBefore
Dict_TagDict_TDA.Dict_Typein
ExtractBooleaninFalse
  
Add_To_Buffer procedure
Purpose : Add a comment to the buffer

in : Item : String to add
Parameter name Type Mode Default
ItemStringin
  
Clear_Buffer procedure
Purpose : Clear the buffer
  
Mark_Instruction procedure
Purpose : Call when an instruction occur

in : Key : line where the occurance is
Parameter name Type Mode Default
KeyStringin
  
Exist function
ReturnBoolean
Purpose : True if a comment exist for the key

in : Key : line where the occurance is
return : True if exist
Parameter name Type Mode Default
KeyStringin
  
Return_Comment function
ReturnString
Purpose : Return the comment associate to the key

in : Key : line where the occurance is
return : The comment
Parameter name Type Mode Default
KeyStringin
  
Return_Header_Comment function
ReturnDict_TDA.Dict_Type
Purpose : return the comment associate to the tags in the header
return : a dico with the comment associate to the tags
  
Delete procedure
Purpose : Clean the abstract machine