Skip to content

Commit 8a36064

Browse files
committed
Renamed options to strip and nostrip
1 parent 0337775 commit 8a36064

5 files changed

Lines changed: 27 additions & 20 deletions

File tree

addon/doxyapp/doxyapp.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ static void findXRefSymbols(FileDef *fd)
133133
QCString(),
134134
fileToString(fd->absFilePath()),
135135
lang,
136-
Config_getBool(STRIP_CODE_COMMENTS),
136+
FALSE,
137137
FALSE,
138138
QCString(),
139139
fd);

addon/doxyparse/doxyparse.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ static void findXRefSymbols(FileDef *fd)
106106

107107
// parse the source code
108108
intf->parseCode(parseList, QCString(), fileToString(fd->absFilePath()), lang,
109-
Config_getBool(STRIP_CODE_COMMENTS), FALSE, QCString(), fd);
109+
FALSE, FALSE, QCString(), fd);
110110
}
111111

112112
static bool ignoreStaticExternalCall(const MemberDef *context, const MemberDef *md) {

doc/commands.dox

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2731,10 +2731,11 @@ Commands for displaying examples
27312731
tag of Doxygen's configuration file.
27322732

27332733
You can add the option `lineno` to enable line numbers for the included code if desired.
2734-
You can add the option `stripcodecomments` that will always hide any special comments
2735-
from the included code irrespective of the setting of
2736-
\ref cfg_strip_code_comments "STRIP_CODE_COMMENTS" or you can add the option
2737-
`nostripcodecomments` that will always show the special comments.
2734+
2735+
You can add the option `strip` that will always hide any special comments
2736+
from the included code, overruling the
2737+
\ref cfg_strip_code_comments "STRIP_CODE_COMMENTS" setting, or add the option
2738+
`nostrip` to always show the special comments.
27382739

27392740
The class and member declarations and definitions inside the code fragment
27402741
are 'remembered' during the parsing of the comment block that contained
@@ -2803,11 +2804,11 @@ Commands for displaying examples
28032804
- The `option` `doc` can be used to treat the file as documentation rather than code.
28042805
- The `option` `local` can be used make Doxygen interpret the code as if it was in the
28052806
class or namespace in which the include command appears, rather than the global namespace.
2806-
- The `option` `stripcodecomments` can be used so that any special comment will always be hidden
2807-
from the included code irrespective of the setting of
2808-
\ref cfg_strip_code_comments "STRIP_CODE_COMMENTS" or you can use the `option`
2809-
`nostripcodecomments` that will always show the special comments. These options have no effect in
2810-
combination with the `option` `doc`.
2807+
- The `option` `strip` can be used to always hide any special comments
2808+
from the included code, overruling the
2809+
\ref cfg_strip_code_comments "STRIP_CODE_COMMENTS" setting, and option
2810+
`nostrip` can be used to always show the special comments.
2811+
These options have no effect in combination with the `option` `doc`.
28112812

28122813
When using option `doc`, there is also the option `raise` that can be specified to raise
28132814
all sections found in the referenced file by a certain amount. For example
@@ -2956,11 +2957,11 @@ Commands for displaying examples
29562957
- The `option` `doc` can be used to treat the file as documentation rather than code.
29572958
- The `option` `local` can be used make Doxygen interpret the code as if it was in the
29582959
class or namespace in which the include command appears, rather than the global namespace.
2959-
- The `option` `stripcodecomments` can be used so that any special comment will always be hidden
2960-
from the included code irrespective of the setting of
2961-
\ref cfg_strip_code_comments "STRIP_CODE_COMMENTS" or you can use the `option`
2962-
`nostripcodecomments` that will always show the special comments. These options have no effect in
2963-
combination with the `option` `doc`.
2960+
- The `option` `strip` can be used to always hide any special comments
2961+
from the included code, overruling the
2962+
\ref cfg_strip_code_comments "STRIP_CODE_COMMENTS" setting, and option
2963+
`nostrip` can be used to always show the special comments.
2964+
These options have no effect in combination with the `option` `doc`.
29642965

29652966
When using option `doc`, there is also the option `raise` that can be specified to raise
29662967
all sections found in the referenced file by a certain amount. For example

src/docnode.cpp

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3602,7 +3602,7 @@ void DocPara::handleIncludeOperator(const QCString &cmdName,DocIncOperator::Type
36023602
auto it2 = children().size()>=2 ? std::prev(it1) : children().end();
36033603
DocNodeVariant *n1 = it1!=children().end() ? &(*it1) : nullptr;
36043604
DocNodeVariant *n2 = it2!=children().end() ? &(*it2) : nullptr;
3605-
//TODO get from context the stripCodeComments()
3605+
//TODO get from context the stripCodeComments()
36063606
bool stripCodeComments = Config_getBool(STRIP_CODE_COMMENTS);
36073607
children().append<DocIncOperator>(parser(),thisVariant(),t,
36083608
parser()->context.token->name,
@@ -3758,8 +3758,14 @@ void DocPara::handleInclude(const QCString &cmdName,DocInclude::Type t)
37583758
return std::find(optList.begin(),optList.end(),kw)!=optList.end();
37593759
};
37603760
localScope = contains("local");
3761-
if (contains("nostripcodecomments")) stripCodeComments = false;
3762-
else if (contains("stripcodecomments")) stripCodeComments = true;
3761+
if (contains("nostrip"))
3762+
{
3763+
stripCodeComments = false;
3764+
}
3765+
else if (contains("strip"))
3766+
{
3767+
stripCodeComments = true;
3768+
}
37633769

37643770
if (t==DocInclude::Include && contains("lineno"))
37653771
{

src/docnode.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,8 +496,8 @@ class DocIncOperator : public DocNode
496496
QCString m_context;
497497
bool m_isFirst = false;
498498
bool m_isLast = false;
499-
bool m_isExample = false;
500499
bool m_stripCodeComments = true;
500+
bool m_isExample = false;
501501
QCString m_exampleFile;
502502
QCString m_includeFileName;
503503
};

0 commit comments

Comments
 (0)