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/pagedef.h | |
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/pagedef.h')
-rw-r--r-- | src/pagedef.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/pagedef.h b/src/pagedef.h index e4d0268..5190405 100644 --- a/src/pagedef.h +++ b/src/pagedef.h @@ -35,6 +35,7 @@ class PageDef : virtual public Definition virtual void setFileName(const char *name) = 0; virtual void setLocalToc(const LocalToc &tl) = 0; virtual void setShowLineNo(bool) = 0; + virtual void setTopLine(int) = 0; // getters virtual DefType definitionType() const = 0; @@ -57,6 +58,7 @@ class PageDef : virtual public Definition virtual Definition *getPageScope() const = 0; virtual QCString displayName(bool=TRUE) const = 0; virtual bool showLineNo() const = 0; + virtual int topLine() const = 0; virtual void writeDocumentation(OutputList &) = 0; virtual void writeTagFile(FTextStream &) = 0; @@ -65,7 +67,7 @@ class PageDef : virtual public Definition }; -PageDef *createPageDef(const char *f,int l,const char *n,const char *d,const char *t); +PageDef *createPageDef(const char *f,int l,int p,const char *n,const char *d,const char *t); class PageSDict : public SDict<PageDef> { |