diff options
author | albert-github <albert.tests@gmail.com> | 2020-09-24 13:20:13 (GMT) |
---|---|---|
committer | albert-github <albert.tests@gmail.com> | 2020-09-24 13:20:13 (GMT) |
commit | 17390b669f7a1017fa937410880da38a540dfa35 (patch) | |
tree | d6f3e41e51c2c6552c979bb460569bd88382877d /src/doxygen.cpp | |
parent | 55e15c86717f38c9b510e4287cb0b4f165b8cb10 (diff) | |
download | Doxygen-17390b669f7a1017fa937410880da38a540dfa35.zip Doxygen-17390b669f7a1017fa937410880da38a540dfa35.tar.gz Doxygen-17390b669f7a1017fa937410880da38a540dfa35.tar.bz2 |
Miscounting of lines in respect to page command
All examples together are a bit big so they are all in the attached file together with the warnings before and after this patch.
When looking at the output we see that a number of lines are off by 1 ore more due to the insertion of extra lines in the code or due to the fact that there is a reference to the start of the documentation of the page and not the line of the page command.
- commentscan.l
in case of a rule contaiinge {DOCNL} this can be `=n` or `\ilinebr` in the later case this should not be replaced by `\n` as this results in an increase of the line count later on.
in case of a page like command also register the line of the command as "topline".
- entry.h, entry.cpp
storage space for the "topline" registering the line of the page like commands.
- doxygen.cpp
setting and using the "topline"
- markdown.cpp, markdown.h
don't add a `\n` as this increases the line count but use the `\ilinebr`
to get correct warnings see to it that when having empty lines at the top of the page and a page is added that the empty lines appear after the page command.
- index.cpp
using the "topline" instead of the "docLine" to get the correct warning
- pagedef.cpp, pagedef.h
set and retrieve the "topline" for page like commands.
- util.cpp, util.h
setting and using the "topline"
in `addRelatedPage` use the known file name and line for the warning regarding the section label
- cite.cpp, context.cpp, reflist.cpp
changed to have good function calls.
Diffstat (limited to 'src/doxygen.cpp')
-rw-r--r-- | src/doxygen.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/doxygen.cpp b/src/doxygen.cpp index ee414e7..992c43e 100644 --- a/src/doxygen.cpp +++ b/src/doxygen.cpp @@ -347,7 +347,7 @@ static void addRelatedPage(Entry *root) } PageDef *pd = addRelatedPage(root->name,root->args,doc, - root->docFile,root->docLine, + root->docFile,root->docLine,root->topLine, root->sli, gd,root->tagInfo(), FALSE, @@ -8372,7 +8372,7 @@ static void findMainPage(Entry *root) QCString title=root->args.stripWhiteSpace(); //QCString indexName=Config_getBool(GENERATE_TREEVIEW)?"main":"index"; QCString indexName="index"; - Doxygen::mainPage = createPageDef(root->docFile,root->docLine, + Doxygen::mainPage = createPageDef(root->docFile,root->docLine,root->topLine, indexName, root->brief+root->doc+root->inbodyDocs,title); //setFileNameForSections(root->anchors,"index",Doxygen::mainPage); Doxygen::mainPage->setBriefDescription(root->brief,root->briefFile,root->briefLine); @@ -8411,7 +8411,7 @@ static void findMainPage(Entry *root) { warn(root->fileName,root->startLine, "found more than one \\mainpage comment block! (first occurrence: %s, line %d), Skipping current block!", - Doxygen::mainPage->docFile().data(),Doxygen::mainPage->docLine()); + Doxygen::mainPage->docFile().data(),Doxygen::mainPage->topLine()); } } for (const auto &e : root->children()) findMainPage(e.get()); @@ -8589,7 +8589,7 @@ static void buildExampleList(Entry *root) } else { - PageDef *pd=createPageDef(root->fileName,root->startLine, + PageDef *pd=createPageDef(root->fileName,root->startLine,root->startLine, root->name,root->brief+root->doc+root->inbodyDocs,root->args); pd->setBriefDescription(root->brief,root->briefFile,root->briefLine); pd->setFileName(convertNameToFile(pd->name()+"-example",FALSE,TRUE)); |