Skip to content

Commit

Permalink
Add commands to handle referenced by relation and references relation
Browse files Browse the repository at this point in the history
Shortened the commands:
- referencedbyrelation        -> showrefby
- hidereferencedbyrelation -> hiderefby
- referencesrelation            -> showrefs
- hidereferencesrelation     -> hiderefs
  • Loading branch information
albert-github committed Oct 30, 2018
1 parent 0697535 commit 6c04363
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 29 deletions.
50 changes: 25 additions & 25 deletions doc/commands.doc
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ documentation:
\refitem cmdheaderfile \\headerfile
\refitem cmdhidecallergraph \\hidecallergraph
\refitem cmdhidecallgraph \\hidecallgraph
\refitem cmdhidereferencedbyrelation \\hidereferencedbyrelation
\refitem cmdhidereferencesrelation \\hidereferencesrelation
\refitem cmdhiderefby \\hiderefby
\refitem cmdhiderefs \\hiderefs
\refitem cmdhideinitializer \\hideinitializer
\refitem cmdhtmlinclude \\htmlinclude
\refitem cmdhtmlonly \\htmlonly
Expand Down Expand Up @@ -158,9 +158,7 @@ documentation:
\refitem cmdpublicsection \\publicsection
\refitem cmdpure \\pure
\refitem cmdref \\ref
\refitem cmdreferencedbyrelation \\refitem
\refitem cmdrefitem \\referencedbyrelation
\refitem cmdreferencesrelation \\referencesrelation
\refitem cmdrefitem \\refitem
\refitem cmdrelated \\related
\refitem cmdrelates \\relates
\refitem cmdrelatedalso \\relatedalso
Expand All @@ -178,6 +176,8 @@ documentation:
\refitem cmdsee \\see
\refitem cmdshort \\short
\refitem cmdshowinitializer \\showinitializer
\refitem cmdshowrefby \\showrefby
\refitem cmdshowrefs \\showrefs
\refitem cmdsince \\since
\refitem cmdskip \\skip
\refitem cmdskipline \\skipline
Expand Down Expand Up @@ -337,9 +337,9 @@ Structural indicators
option \ref cfg_caller_graph "CALLER_GRAPH"

<hr>
\section cmdreferencedbyrelation \\referencedbyrelation
\section cmdshowrefby \\showrefby

\addindex \\referencedbyrelation
\addindex \\showrefby
When this command is put in a comment block of a function, method or variable,
then doxygen will generate an overview for that function, method, variable of
the, documented, funcions and methods that call / use it.
Expand All @@ -348,15 +348,15 @@ Structural indicators
\note The completeness (and correctness) of the overview depends on the
doxygen code parser which is not perfect.

\sa section \ref cmdreferencesrelation "\\referencesrelation",
section \ref cmdhidereferencedbyrelation "\\hidereferencedbyrelation",
section \ref cmdhidereferencesrelation "\\hidereferencesrelation" and
\sa section \ref cmdshowrefs "\\showrefs",
section \ref cmdhiderefby "\\hiderefby",
section \ref cmdhiderefs "\\hiderefs" and
option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION"

<hr>
\section cmdhidereferencedbyrelation \\hidereferencedbyrelation
\section cmdhiderefby \\hiderefby

\addindex \\hidereferencedbyrelation
\addindex \\hiderefby
When this command is put in a comment block of a function, method or variable
then doxygen will not generate an overview for that function, method or
variable of the functions and methods that call / use it.
Expand All @@ -365,15 +365,15 @@ Structural indicators
\note The completeness (and correctness) of the overview depends on the
doxygen code parser which is not perfect.

\sa section \ref cmdreferencesrelation "\\referencesrelation",
section \ref cmdreferencedbyrelation "\\referencedbyrelation",
section \ref cmdhidereferencesrelation "\\hidereferencesrelation" and
\sa section \ref cmdshowrefs "\\showrefs",
section \ref cmdshowrefby "\\showrefby",
section \ref cmdhiderefs "\\hiderefs" and
option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION"

<hr>
\section cmdreferencesrelation \\referencesrelation
\section cmdshowrefs \\showrefs

\addindex \\referencesrelation
\addindex \\showrefs
When this command is put in a comment block of a function or method,
then doxygen will generate an overview for that function or method of the
functions and methods that call it.
Expand All @@ -382,15 +382,15 @@ Structural indicators
\note The completeness (and correctness) of the overview depends on the
doxygen code parser which is not perfect.

\sa section \ref cmdreferencedbyrelation "\\referencedbyrelation",
section \ref cmdhidereferencedbyrelation "\\hidereferencedbyrelation",
section \ref cmdhidereferencesrelation "\\hidereferencesrelation" and
\sa section \ref cmdshowrefby "\\showrefby",
section \ref cmdhiderefby "\\hiderefby",
section \ref cmdhiderefs "\\hiderefs" and
option \ref cfg_references_relation "REFERENCES_RELATION"

<hr>
\section cmdhidereferencesrelation \\hidereferencesrelation
\section cmdhiderefs \\hiderefs

\addindex \\hidereferencesrelation
\addindex \\hiderefs
When this command is put in a comment block of a function or method
and then doxygen will not generate an overview for that function or method of
the functions and methods that call it.
Expand All @@ -399,9 +399,9 @@ Structural indicators
\note The completeness (and correctness) of the overview depends on the
doxygen code parser which is not perfect.

\sa section \ref cmdreferencesrelation "\\referencesrelation",
section \ref cmdreferencedbyrelation "\\referencedbyrelation",
section \ref cmdhidereferencedbyrelation "\\hidereferencedbyrelation" and
\sa section \ref cmdshowrefs "\\showrefs",
section \ref cmdshowrefby "\\showrefby",
section \ref cmdhiderefby "\\hiderefby" and
option \ref cfg_references_relation "REFERENCES_RELATION"

<hr>
Expand Down
8 changes: 4 additions & 4 deletions src/commentscan.l
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,10 @@ static DocCmdMap docCmdMap[] =
{ "hidecallgraph", &handleHideCallgraph, FALSE },
{ "callergraph", &handleCallergraph, FALSE },
{ "hidecallergraph", &handleHideCallergraph, FALSE },
{ "referencedbyrelation", &handleReferencedByRelation, FALSE },
{ "hidereferencedbyrelation", &handleHideReferencedByRelation, FALSE },
{ "referencesrelation", &handleReferencesRelation, FALSE },
{ "hidereferencesrelation", &handleHideReferencesRelation, FALSE },
{ "showrefby", &handleReferencedByRelation, FALSE },
{ "hiderefby", &handleHideReferencedByRelation, FALSE },
{ "showrefs", &handleReferencesRelation, FALSE },
{ "hiderefs", &handleHideReferencesRelation, FALSE },
{ "internal", &handleInternal, TRUE },
{ "_linebr", &handleLineBr, FALSE },
{ "static", &handleStatic, FALSE },
Expand Down

0 comments on commit 6c04363

Please sign in to comment.