diff options
Diffstat (limited to 'src/definition.h')
| -rw-r--r-- | src/definition.h | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/src/definition.h b/src/definition.h index 394bc79..09d2cd0 100644 --- a/src/definition.h +++ b/src/definition.h @@ -123,9 +123,16 @@ class Definition /*! returns the line number at which the definition was found */ int getDefLine() const { return m_defLine; } - /*! Returns TRUE iff the definition is documented */ + /*! Returns TRUE iff the definition is documented + * (which could be generated documentation) + * @see hasUserDocumentation() + */ virtual bool hasDocumentation() const; + /*! Returns TRUE iff the definition is documented by the user. */ + virtual bool hasUserDocumentation() const; + + /*! Returns TRUE iff it is possible to link to this item within this * project. */ @@ -136,6 +143,16 @@ class Definition */ virtual bool isLinkable() const = 0; + /*! Returns TRUE iff the name is part of this project and + * may appear in the output + */ + virtual bool isVisibleInProject() const + { return m_hidden || isLinkableInProject(); } + + /*! Returns TRUE iff the name may appear in the output */ + virtual bool isVisible() const + { return m_hidden || isLinkable(); } + /*! If this definition was imported via a tag file, this function * returns the tagfile for the external project. This can be * translated into an external link target via |