Modules | Files | Inheritance Tree | Inheritance Graph | Name Index | Config
namespace Synopsis::Parser::C++::AST
class Comment
Files: Synopsis/Parser/C++/syn/ast.hh
Comment-inheritance Scopes/Synopsis/Parser/C++/FakeGC/cleanup.html

Encapsulation of one Comment, which may span multiple lines. Each comment encapsulates one block or a block of // comments on adjacent lines. If extract_tails is set, then comments will be added even when they are not adjacent to a declaration - these comments will be marked as "suspect". Most of these will be discarded by the Linker, unless they have appropriate markings such as "//.< comment for previous decl"


Public Typedefs Summary:
std::vector<Comment*>vector
A vector of Comments [Source]

Public Member functions Summary:
 constructorComment(SourceFile* file, int line, const std::string& text, bool suspect = false)
Constructor [Source]
 SourceFile*file()
Returns the filename of this comment [Source]
 intline()
Returns the line number of the start of this comment [Source]
 const std::string&text()
Returns the text of this comment [Source]
 voidset_suspect(bool suspect)
Sets whether this comment is suspicious [Source]
 boolis_suspect()
Returns whether this comment is suspicious [Source]

Private Data members Summary:
SourceFile*m_file
The file [Source]
intm_line
The first line number [Source]
std::stringm_text
The text [Source]
boolm_suspect
True if this comment is probably not needed. [Source]

Public Data members Inherited from FakeGC::cleanup
cleanup_next

Private Data member Details:
bool m_suspect

True if this comment is probably not needed. The exception is comments which will be used as "tails", eg: //.< comment for previous decl