Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
D
doxverilog
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Commits
Open sidebar
Elphel
doxverilog
Commits
d3de023d
Commit
d3de023d
authored
Nov 29, 2013
by
Dimitri van Heesch
Browse files
Options
Browse Files
Download
Plain Diff
Merge branch 'master' into template
Conflicts: src/memberdef.cpp src/memberdef.h
parents
00b7d393
006dd531
Changes
4
Show whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
80 additions
and
12 deletions
+80
-12
config.doc
doc/config.doc
+27
-12
config.xml
src/config.xml
+9
-0
memberdef.cpp
src/memberdef.cpp
+43
-0
memberdef.h
src/memberdef.h
+1
-0
No files found.
doc/config.doc
View file @
d3de023d
...
...
@@ -88,8 +88,8 @@ followed by the descriptions of the tags grouped by category.
\
refitem
cfg_compact_rtf
COMPACT_RTF
\
refitem
cfg_cpp_cli_support
CPP_CLI_SUPPORT
\
refitem
cfg_create_subdirs
CREATE_SUBDIRS
\
refitem
cfg_dia_path
DIA_PATH
\
refitem
cfg_diafile_dirs
DIAFILE_DIRS
\
refitem
cfg_dia_path
DIA_PATH
\
refitem
cfg_directory_graph
DIRECTORY_GRAPH
\
refitem
cfg_disable_index
DISABLE_INDEX
\
refitem
cfg_distribute_group_doc
DISTRIBUTE_GROUP_DOC
...
...
@@ -278,6 +278,7 @@ followed by the descriptions of the tags grouped by category.
\
refitem
cfg_server_based_search
SERVER_BASED_SEARCH
\
refitem
cfg_short_names
SHORT_NAMES
\
refitem
cfg_show_files
SHOW_FILES
\
refitem
cfg_show_grouped_memb_inc
SHOW_GROUPED_MEMB_INC
\
refitem
cfg_show_include_files
SHOW_INCLUDE_FILES
\
refitem
cfg_show_namespaces
SHOW_NAMESPACES
\
refitem
cfg_show_used_files
SHOW_USED_FILES
...
...
@@ -397,6 +398,7 @@ The default value is: <code>NO</code>.
Possible
values
are
:
<
code
>
Afrikaans
</
code
>,
<
code
>
Arabic
</
code
>,
<
code
>
Armenian
</
code
>,
<
code
>
Brazilian
</
code
>,
<
code
>
Catalan
</
code
>,
<
code
>
Chinese
</
code
>,
...
...
@@ -405,28 +407,31 @@ Possible values are:
<
code
>
Czech
</
code
>,
<
code
>
Danish
</
code
>,
<
code
>
Dutch
</
code
>,
<
code
>
English
</
code
>,
<
code
>
English
</
code
>
(
United
States
)
,
<
code
>
Esperanto
</
code
>,
<
code
>
Farsi
</
code
>,
<
code
>
Farsi
</
code
>
(
Persian
)
,
<
code
>
Finnish
</
code
>,
<
code
>
French
</
code
>,
<
code
>
German
</
code
>,
<
code
>
Greek
</
code
>,
<
code
>
Hungarian
</
code
>,
<
code
>
Indonesian
</
code
>,
<
code
>
Italian
</
code
>,
<
code
>
Japanese
</
code
>,
<
code
>
Japanese
-
en
</
code
>,
<
code
>
Japanese
-
en
</
code
>
(
Japanese
with
English
messages
)
,
<
code
>
Korean
</
code
>,
<
code
>
Korean
-
en
</
code
>,
<
code
>
Korean
-
en
</
code
>
(
Korean
with
English
messages
)
,
<
code
>
Latvian
</
code
>,
<
code
>
Norweg
ian
</
code
>,
<
code
>
Lithuan
ian
</
code
>,
<
code
>
Macedonian
</
code
>,
<
code
>
Persian
</
code
>,
<
code
>
Norwegian
</
code
>,
<
code
>
Persian
</
code
>
(
Farsi
),
<
code
>
Polish
</
code
>,
<
code
>
Portuguese
</
code
>,
<
code
>
Romanian
</
code
>,
<
code
>
Russian
</
code
>,
<
code
>
Serbian
</
code
>,
<
code
>
Serbian
-
Cyrillic
</
code
>,
<
code
>
Slovak
</
code
>,
<
code
>
Slovene
</
code
>,
<
code
>
Spanish
</
code
>,
...
...
@@ -1022,6 +1027,16 @@ The default value is: <code>NO</code>.
The
default
value
is
:
<
code
>
YES
</
code
>.
\
anchor
cfg_show_grouped_memb_inc
<
dt
>\
c
SHOW_GROUPED_MEMB_INC
<
dd
>
\
addindex
SHOW_GROUPED_MEMB_INC
If
the
SHOW_GROUPED_MEMB_INC
tag
is
set
to
\
c
YES
then
Doxygen
will
add
for
each
grouped
member
an
include
statement
to
the
documentation
,
telling
the
reader
which
file
to
include
in
order
to
use
the
member
.
The
default
value
is
:
<
code
>
NO
</
code
>.
\
anchor
cfg_force_local_includes
<
dt
>\
c
FORCE_LOCAL_INCLUDES
<
dd
>
\
addindex
FORCE_LOCAL_INCLUDES
...
...
@@ -3311,10 +3326,10 @@ The default value is: <code>YES</code>.
\
anchor
cfg_dia_path
<
dt
>\
c
DIA_PATH
<
dd
>
\
addindex
DIA_PATH
You
can
include
diagrams
drawn
in
dia
using
the
\
ref
cmddiafile
"
\\
diafile"
command
.
Doxygen
will
run
dia
to
produce
the
appropriate
image
and
insert
it
in
the
documentation
.
The
<
code
>
DIA_PATH
</
code
>
tag
allows
you
to
specify
the
directory
where
the
\
c
dia
binary
resides
.
If
left
empty
the
tool
is
assumed
to
be
found
in
the
default
search
path
.
You
can
include
diagrams
made
with
dia
in
doxygen
documentation
.
Doxygen
will
then
run
dia
to
produce
the
diagram
and
insert
it
in
the
documentation
.
The
DIA_PATH
tag
allows
you
to
specify
the
directory
where
the
dia
binary
resides
.
If
left
empty
dia
is
assumed
to
be
found
in
the
default
search
path
.
\
anchor
cfg_hide_undoc_relations
<
dt
>\
c
HIDE_UNDOC_RELATIONS
<
dd
>
...
...
@@ -3607,7 +3622,7 @@ This tag requires that the tag \ref cfg_have_dot "HAVE_DOT" is set to \c YES.
\addindex DIAFILE_DIRS
The \c DIAFILE_DIRS tag can be used to specify one or more directories that
contain dia files that are included in the documentation (see the
\ref cmd
dia
file "\\diafile" command).
\ref cmd
msc
file "\\diafile" command).
\anchor cfg_dot_graph_max_nodes
<dt>\c DOT_GRAPH_MAX_NODES <dd>
...
...
src/config.xml
View file @
d3de023d
...
...
@@ -879,6 +879,15 @@ Go to the <a href="commands.html">next</a> section or return to the
If the \c SHOW_INCLUDE_FILES tag is set to \c YES then doxygen
will put a list of the files that are included by a file in the documentation
of that file.
]]>
</docs>
</option>
<option
type=
'bool'
id=
'SHOW_GROUPED_MEMB_INC'
defval=
'0'
>
<docs>
<![CDATA[
If the SHOW_GROUPED_MEMB_INC tag is set to \c YES then Doxygen
will add for each grouped member an include statement to the documentation,
telling the reader which file to include in order to use the member.
]]>
</docs>
</option>
...
...
src/memberdef.cpp
View file @
d3de023d
...
...
@@ -2447,6 +2447,47 @@ QCString MemberDef::displayDefinition() const
return
substitute
(
ldef
,
"::"
,
sep
);
}
void
MemberDef
::
_writeGroupInclude
(
OutputList
&
ol
,
bool
inGroup
)
{
// only write out the include file if this is not part of a class or file
// definition
static
bool
showGroupedMembInc
=
Config_getBool
(
"SHOW_GROUPED_MEMB_INC"
);
FileDef
*
fd
=
getFileDef
();
QCString
nm
;
if
(
fd
)
nm
=
getFileDef
()
->
docName
();
if
(
inGroup
&&
fd
&&
showGroupedMembInc
&&
!
nm
.
isEmpty
())
{
ol
.
startParagraph
();
ol
.
startTypewriter
();
SrcLangExt
lang
=
getLanguage
();
bool
isIDLorJava
=
lang
==
SrcLangExt_IDL
||
lang
==
SrcLangExt_Java
;
if
(
isIDLorJava
)
{
ol
.
docify
(
"import "
);
}
else
{
ol
.
docify
(
"#include "
);
}
if
(
isIDLorJava
)
ol
.
docify
(
"
\"
"
);
else
ol
.
docify
(
"<"
);
if
(
fd
&&
fd
->
isLinkable
())
{
ol
.
writeObjectLink
(
fd
->
getReference
(),
fd
->
getOutputFileBase
(),
fd
->
anchor
(),
nm
);
}
else
{
ol
.
docify
(
nm
);
}
if
(
isIDLorJava
)
ol
.
docify
(
"
\"
"
);
else
ol
.
docify
(
">"
);
ol
.
endTypewriter
();
ol
.
endParagraph
();
}
}
/*! Writes the "detailed documentation" section of this member to
* all active output formats.
*/
...
...
@@ -2775,6 +2816,8 @@ void MemberDef::writeDocumentation(MemberList *ml,OutputList &ol,
ol
.
endDoxyAnchor
(
cfname
,
memAnchor
);
ol
.
startIndent
();
_writeGroupInclude
(
ol
,
inGroup
);
/* write multi-line initializer (if any) */
if
(
hasMultiLineInitializer
()
//initLines>0 && ((initLines<maxInitLines && userInitLines==-1) // implicitly enabled
...
...
src/memberdef.h
View file @
d3de023d
...
...
@@ -386,6 +386,7 @@ class MemberDef : public Definition
void
_computeLinkableInProject
();
void
_computeIsConstructor
();
void
_computeIsDestructor
();
void
_writeGroupInclude
(
OutputList
&
ol
,
bool
inGroup
);
void
_writeCallGraph
(
OutputList
&
ol
);
void
_writeCallerGraph
(
OutputList
&
ol
);
void
_writeReimplements
(
OutputList
&
ol
);
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment