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.

1 files changed, 20 insertions, 6 deletions

diff --git a/src/pagedef.cpp b/src/pagedef.cpp
index 75e50ed..cad0615 100644
--- a/src/pagedef.cpp
+++ b/src/pagedef.cpp
@@ -32,12 +32,13 @@
 class PageDefImpl : public DefinitionImpl, public PageDef
 {
   public:
-    PageDefImpl(const char *f,int l,const char *n,const char *d,const char *t);
+    PageDefImpl(const char *f,int l,int p,const char *n,const char *d,const char *t);
     virtual ~PageDefImpl();
 
     virtual void setFileName(const char *name);
     virtual void setLocalToc(const LocalToc &tl);
     virtual void setShowLineNo(bool);
+    virtual void setTopLine(int);
     virtual DefType definitionType() const { return TypePage; }
     virtual bool isLinkableInProject() const { return /*hasDocumentation() &&*/ !isReference(); }
     virtual bool isLinkable() const { return isLinkableInProject() || isReference(); }
@@ -58,6 +59,7 @@ class PageDefImpl : public DefinitionImpl, public PageDef
     virtual Definition *getPageScope() const { return m_pageScope; }
     virtual QCString displayName(bool=TRUE) const { return hasTitle() ? m_title : DefinitionImpl::name(); }
     virtual bool showLineNo() const;
+    virtual int topLine() const;
     virtual void writeDocumentation(OutputList &ol);
     virtual void writeTagFile(FTextStream &);
     virtual void setNestingLevel(int l);
@@ -71,16 +73,17 @@ class PageDefImpl : public DefinitionImpl, public PageDef
     int m_nestingLevel;
     LocalToc m_localToc;
     bool m_showLineNo;
+    int  m_topLine;
 };
 
-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)
 {
-  return new PageDefImpl(f,l,n,d,t);
+  return new PageDefImpl(f,l,p,n,d,t);
 }
 
 //------------------------------------------------------------------------------------------
 
-PageDefImpl::PageDefImpl(const char *f,int l,const char *n,
+PageDefImpl::PageDefImpl(const char *f,int l,int p,const char *n,
                  const char *d,const char *t)
  : DefinitionImpl(f,l,1,n), m_title(t)
 {
@@ -90,6 +93,7 @@ PageDefImpl::PageDefImpl(const char *f,int l,const char *n,
   m_nestingLevel = 0;
   m_fileName = ::convertNameToFile(n,FALSE,TRUE);
   m_showLineNo = FALSE;
+  m_topLine=p;
 }
 
 PageDefImpl::~PageDefImpl()
@@ -230,7 +234,7 @@ void PageDefImpl::writeDocumentation(OutputList &ol)
 
     if (si->title() != manPageName)
     {
-      ol.generateDoc(docFile(),docLine(),this,0,si->title(),TRUE,FALSE,
+      ol.generateDoc(docFile(),topLine(),this,0,si->title(),TRUE,FALSE,
                      0,TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
       ol.endSection(si->label(),si->type());
     }
@@ -250,7 +254,7 @@ void PageDefImpl::writeDocumentation(OutputList &ol)
     ol.startPageDoc(si->title());
     //ol.startSection(si->label,si->title,si->type);
     startTitle(ol,getOutputFileBase(),this);
-    ol.generateDoc(docFile(),docLine(),this,0,si->title(),TRUE,FALSE,
+    ol.generateDoc(docFile(),topLine(),this,0,si->title(),TRUE,FALSE,
                    0,TRUE,FALSE,Config_getBool(MARKDOWN_SUPPORT));
     //stringToSearchIndex(getOutputFileBase(),
     //                    theTranslator->trPage(TRUE,TRUE)+" "+si->title,
@@ -394,6 +398,16 @@ bool PageDefImpl::showLineNo() const
   return m_showLineNo;
 }
 
+void PageDefImpl::setTopLine(int p)
+{
+  m_topLine = p;
+}
+
+int PageDefImpl::topLine() const
+{
+  return m_topLine;
+}
+
 bool PageDefImpl::hasTitle() const
 {
   return !m_title.isEmpty() && m_title.lower()!="notitle";