class FileEntries::FileElement :  public virtual  AutoComment

Base class for any documented element.

Every element obviously has a comment. Every element must supply two basic properties, name and ref. Other properties are optional, i.e. have default versions defined in terms of name and ref, but an element may override those to implement additional features.

AutoComment is a virtual base class since we compose some elements from other elements, stillyet every element has exactly one comment. Here is, for example, the composition of a ``C++'' class variable,

                                 
             AutoComment         
                ­                
             Element             
                ­                
         ----------------        
        ­                ­       
    ClassElement       Variable  
        ­                ­       
         ----------------        
                ­                
           ClassVariable         

Where ClassElement is the base class of any class element, Variable is file level (global) variable and ClassVariable is a class variable (e.g. a member).

Public members: