Merge branch 'master' of github.com:doxygen/doxygen

19 files changed, 84 insertions, 24 deletions

diff --git a/README.md b/README.md
index 8b30cdf..b24a480 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,8 @@ The latest binaries and source of Doxygen can be downloaded from:
 
 Developers
 ---------
-* Build Status: <a href="https://travis-ci.org/doxygen/doxygen"><img src="https://secure.travis-ci.org/doxygen/doxygen.png?branch=master"/></a>
+* Linux Build Status: <a href="https://travis-ci.org/doxygen/doxygen"><img src="https://secure.travis-ci.org/doxygen/doxygen.png?branch=master"/></a>
+* Windows Build Status: <a href="https://ci.appveyor.com/project/doxygen/doxygen"><img src="https://ci.appveyor.com/api/projects/status/github/doxygen/doxygen"/></a>
 
 * Coverity Scan Build Status: <a href="https://scan.coverity.com/projects/2860"> <img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/2860/badge.svg"/> </a>
 
diff --git a/appveyor.yml b/appveyor.yml
new file mode 100644
index 0000000..05e726c
--- /dev/null
+++ b/appveyor.yml
@@ -0,0 +1,48 @@
+image: Visual Studio 2015
+
+configuration:
+  - Release
+  - Debug
+
+platform:
+  - x64
+  - Win32
+
+environment:
+  # VS VERSION IN CMAKE STYLE
+  matrix:
+#    - VSVERSION: "15 2017", disabled until it starts working
+    - VSVERSION: "14 2015"
+
+init:
+  - cmake --version
+  - perl --version
+  - msbuild /version
+
+install:
+  - ps: Invoke-WebRequest https://github.com/lexxmark/winflexbison/releases/download/v2.5.15/win_flex_bison-2.5.15.zip -OutFile flex.zip
+  - 7z x flex.zip -oC:\deps\flex
+  - ps: Invoke-WebRequest https://github.com/ArtifexSoftware/ghostpdl-downloads/releases/download/gs924/gs924w32.exe -OutFile gswin32c.exe
+  - gswin32c /S /D=C:\deps\ghostscript
+  - ps: choco install -y miktex
+  - refreshenv
+  - pip install conan
+  - conan install libxml2/2.9.8@bincrafters/stable -g virtualrunenv
+  - activate_run.bat
+  - set "PATH=%PATH%;C:\deps\ghostscript\bin;C:\deps\flex"
+
+before_build:
+  - if "%platform%"=="Win32" ( set "CMAKE_GENERATOR_NAME=Visual Studio %VSVERSION%" )
+  - if "%platform%"=="x64" ( set "CMAKE_GENERATOR_NAME=Visual Studio %VSVERSION% Win64")
+  - mkdir build
+  - cd build
+  - cmake -G "%CMAKE_GENERATOR_NAME%" ..
+
+build:
+  project: "build\\PACKAGE.vcxproj"
+  parallel: false
+
+test_script:
+  - msbuild "testing\tests.vcxproj" /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
+  - cmake -G "%CMAKE_GENERATOR_NAME%" -D build_doc=ON ..
+  - msbuild "doc\docs.vcxproj" /logger:"C:\Program Files\AppVeyor\BuildAgent\Appveyor.MSBuildLogger.dll"
diff --git a/doc/changelog.doc b/doc/changelog.doc
index 0b245b6..3ba6787 100644
--- a/doc/changelog.doc
+++ b/doc/changelog.doc
@@ -718,7 +718,7 @@
 <li>Bug <a href="https://github.com/doxygen/doxygen/issues/5569">5569</a> - Fix a potential null pointer dereference in src/searchindex.cpp [<a href="http://github.com/doxygen/doxygen/commit/e21aaadb920775f431a27957542da80e39d0c947">view</a>]</li>
 <li>Bug <a href="https://github.com/doxygen/doxygen/issues/5570">5570</a> - Fix wrong pointer initialization in src/definition.cpp [<a href="http://github.com/doxygen/doxygen/commit/cb5d8e6198fe0d0852fb06d6fa18b8ae2682e2c0">view</a>]</li>
 <li>Bug <a href="https://github.com/doxygen/doxygen/issues/5571">5571</a> - Fix potential modulo by zero in src/template.cpp [<a href="http://github.com/doxygen/doxygen/commit/c4007c3abea9c8494bf32181a1352b5366bede69">view</a>]</li>
-<li>Bug <a href="https://github.com/doxygen/doxygen/issues/5572">5572</a> - Reached end of file while still insided a (nested) comment in Markdown [<a href="http://github.com/doxygen/doxygen/commit/c7f7c954ec1356e7f361da0d655c72ca0012a0cf">view</a>]</li>
+<li>Bug <a href="https://github.com/doxygen/doxygen/issues/5572">5572</a> - Reached end of file while still inside a (nested) comment in Markdown [<a href="http://github.com/doxygen/doxygen/commit/c7f7c954ec1356e7f361da0d655c72ca0012a0cf">view</a>]</li>
 <li>Bug <a href="https://github.com/doxygen/doxygen/issues/5573">5573</a> - Fix a terminating null character after fread in src/filedef.cpp [<a href="http://github.com/doxygen/doxygen/commit/a4003db44dfb624c03b7e0a518e368d3e4b8c1ca">view</a>]</li>
 <li>Bug <a href="https://github.com/doxygen/doxygen/issues/5574">5574</a> - Remove not needed variable initialization in src/classdef.cpp [<a href="http://github.com/doxygen/doxygen/commit/5f01852bbfd3c81320ee4aa8cd45875a80b50ee1">view</a>]</li>
 <li>Bug <a href="https://github.com/doxygen/doxygen/issues/5575">5575</a> - Remove not needed pointer initialization in src/entry.cpp [<a href="http://github.com/doxygen/doxygen/commit/88832b15f1256846b1228ac411d270c6d092a50b">view</a>]</li>
@@ -2803,7 +2803,7 @@ make sure you add the following:
 <li>   id <a href="https://github.com/doxygen/doxygen/issues/3190">3190</a>: dropped support for a4wide paper format for LaTeX, since
        it is on the LaTeX taboo list.</li>
 <li>   id <a href="https://github.com/doxygen/doxygen/issues/3261">3261</a>: Behaviour of CLASS_DIAGRAM=NO in combination with
-       HAVE_DOT=YES, was not propely documented.</li>
+       HAVE_DOT=YES, was not properly documented.</li>
 <li>   id <a href="https://github.com/doxygen/doxygen/issues/3332">3332</a>: Python comments for next class or method could end up in
        code of a method/class when enabling INLINE_SOURCES.</li>
 <li>   id <a href="https://github.com/doxygen/doxygen/issues/3688">3688</a>: Fixed problem handling nested classes in Python.</li>
diff --git a/doc/install.doc b/doc/install.doc
index 497a0c0..519ee47 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -36,6 +36,7 @@ following to build the executable:
     \addindex make
     \addindex strip
     \addindex python
+<li>You need \c python (version 2.6 or higher, see https://www.python.org).
 <li>In order to generate a \c Makefile for your platform, you need 
     <a href="https://cmake.org/">cmake</a> version 2.8.12 or later.
     \addindex cmake
@@ -151,6 +152,7 @@ standard installation procedure that is required for these packages.
 
 From version 1.8.10 onwards, build files need to be generated by cmake.
 cmake can be downloaded from https://cmake.org/download/
+\addindex cmake
 
 At the moment only the express version of Visual Studio 2013 is tested,
 but other version might also work.
@@ -160,9 +162,12 @@ Alternatively, you can compile doxygen
 <a href="https://en.wikipedia.org/wiki/Cygwin">Cygwin</a>
 or <a href="http://www.mingw.org/">MinGW</a>.
 
+\addindex flex
+\addindex bison
 The next step is to install modern versions of \c bison and \c flex
 (see https://sourceforge.net/projects/winflexbison/. After installation and adding them to
 your `path` rename `win_flex.exe` to `flex.exe` and `win_bison.exe` to `bison.exe`)
+\addindex python
 Furthermore you have to install \c python (version 2.6 or higher, see https://www.python.org).
 These packages are needed during the compilation process.
 
diff --git a/src/classdef.cpp b/src/classdef.cpp
index 1d72073..52aa96b 100644
--- a/src/classdef.cpp
+++ b/src/classdef.cpp
@@ -1223,7 +1223,7 @@ void ClassDef::writeInheritanceGraph(OutputList &ol)
     }
   }
   else if (Config_getBool(CLASS_DIAGRAMS) && count>0)
-    // write class diagram using build-in generator
+    // write class diagram using built-in generator
   {
     ClassDiagram diagram(this); // create a diagram of this class.
     ol.startClassDiagram();
diff --git a/src/code.l b/src/code.l
index e5e0361..87dc1fe 100644
--- a/src/code.l
+++ b/src/code.l
@@ -1324,7 +1324,9 @@ static void generateFunctionLink(CodeOutputInterface &ol,const char *funcName)
   //CodeClassDef *ccd=0;
   ClassDef *ccd=0;
   QCString locScope=g_classScope;
-  QCString locFunc=removeRedundantWhiteSpace(funcName);
+  QString qq=removeRedundantWhiteSpace(funcName);
+  if (g_insidePHP && qq.startsWith("self::")) qq=qq.mid(4);
+  QCString locFunc(qq.data());
   QCString funcScope;
   QCString funcWithScope=locFunc;
   QCString funcWithFullScope=locFunc;
diff --git a/src/ftvhelp.cpp b/src/ftvhelp.cpp
index cee39f2..8c46fd5 100644
--- a/src/ftvhelp.cpp
+++ b/src/ftvhelp.cpp
@@ -171,11 +171,10 @@ void FTVHelp::decContentsDepth()
 
 /*! Add a list item to the contents file.
  *  \param isDir TRUE if the item is a directory, FALSE if it is a text
- *  \param name The name of the item.
+ *  \param name the name of the item.
  *  \param ref  the URL of to the item.
  *  \param file the file containing the definition of the item
  *  \param anchor the anchor within the file.
- *  \param name the name of the item.
  *  \param separateIndex put the entries in a separate index file
  *  \param addToNavIndex add this entry to the quick navigation index
  *  \param def Definition corresponding to this entry
diff --git a/src/latexgen.cpp b/src/latexgen.cpp
index 204683e..13a88a9 100644
--- a/src/latexgen.cpp
+++ b/src/latexgen.cpp
@@ -2159,7 +2159,7 @@ void LatexGenerator::endParameterName(bool last,bool /*emptyList*/,bool closeBra
 void LatexGenerator::exceptionEntry(const char* prefix,bool closeBracket)
 {
   if (prefix)
-      t << " " << prefix;
+      t << " " << prefix << "(";
   else if (closeBracket)
       t << ")";
   t << " ";
diff --git a/src/mangen.cpp b/src/mangen.cpp
index 2a10db6..b3ae732 100644
--- a/src/mangen.cpp
+++ b/src/mangen.cpp
@@ -34,7 +34,7 @@
 static QCString getExtension()
 {
   /*
-   * [.][nuber][rest]
+   * [.][number][rest]
    * in case of . missing, just ignore it
    * in case number missing, just place a 3 in front of it
    */
diff --git a/src/markdown.cpp b/src/markdown.cpp
index dff64ff..c19d6db 100644
--- a/src/markdown.cpp
+++ b/src/markdown.cpp
@@ -406,7 +406,7 @@ static int processEmphasis2(GrowBuf &out, const char *data, int size, char c)
   return 0;
 }
 
-/** Parsing tripple emphasis.
+/** Parsing triple emphasis.
  *  Finds the first closing tag, and delegates to the other emph 
  */
 static int processEmphasis3(GrowBuf &out, const char *data, int size, char c)
diff --git a/src/pycode.l b/src/pycode.l
index 1b176d6..dfa383f 100644
--- a/src/pycode.l
+++ b/src/pycode.l
@@ -1311,7 +1311,7 @@ TARGET           ({IDENTIFIER}|"("{TARGET_LIST}")"|"["{TARGET_LIST}"]"|{ATTRIBUT
     \\.			       { // espaced char
   		                 codify(yytext);
                                }
-    {STRINGPREFIX}?{TRIDOUBLEQUOTE} { // tripple double quotes
+    {STRINGPREFIX}?{TRIDOUBLEQUOTE} { // triple double quotes
   		                 codify(yytext);
       			       }
     "'"			       { // end of the string
@@ -1334,7 +1334,7 @@ TARGET           ({IDENTIFIER}|"("{TARGET_LIST}")"|"["{TARGET_LIST}"]"|{ATTRIBUT
     \\.			       { // espaced char
   		                 codify(yytext);
                                }
-    {STRINGPREFIX}?{TRISINGLEQUOTE} { // tripple single quotes
+    {STRINGPREFIX}?{TRISINGLEQUOTE} { // triple single quotes
   		                 codify(yytext);
       			       }
     "\""		       { // end of the string
diff --git a/src/pyscanner.l b/src/pyscanner.l
index 4718e3b..7b5a424 100644
--- a/src/pyscanner.l
+++ b/src/pyscanner.l
@@ -118,6 +118,7 @@ static bool             g_packageCommentAllowed;
 static bool             g_start_init = FALSE;
 static int              g_search_count = 0;
 
+static QCString         g_argType = "";
 //-----------------------------------------------------------------------------
 
 
@@ -959,12 +960,16 @@ STARTDOCSYMS      "##"
     ({BB}|",")          {
                         }
 
+    [\*]+               {
+                          g_argType = yytext;
+                        }
     {IDENTIFIER}        { // Name of parameter
 			  lineCount();
 			  Argument *a = new Argument;
 			  current->argList->append(a);
 			  current->argList->getLast()->name = QCString(yytext).stripWhiteSpace();
-			  current->argList->getLast()->type = "";
+			  current->argList->getLast()->type = g_argType;
+                          g_argType = "";
                         }
     "="		        { // default value
                           // TODO: this rule is too simple, need to be able to
@@ -1508,7 +1513,7 @@ STARTDOCSYMS      "##"
     \\.			       { // espaced char
       			         addToString(yytext);
                                }
-    "\"\"\""		       { // tripple double quotes
+    "\"\"\""		       { // triple double quotes
       			         addToString(yytext);
       			       }
     "'"			       { // end of the string
@@ -1531,7 +1536,7 @@ STARTDOCSYMS      "##"
     \\.			       { // espaced char
       			         addToString(yytext);
                                }
-    "'''"		       { // tripple single quotes
+    "'''"		       { // triple single quotes
       			         addToString(yytext);
       			       }
     "\""		       { // end of the string
diff --git a/src/res2cc_cmd.py b/src/res2cc_cmd.py
index 7e0322d..86d999d 100755
--- a/src/res2cc_cmd.py
+++ b/src/res2cc_cmd.py
@@ -98,10 +98,11 @@ def main():
 	directory = sys.argv[1]
 	files = []
 	for dirName, subdirList, fileList in walk(directory):
-		for fname in sorted(fileList):
+		for fname in fileList:
 			subdir = dirName[len(directory)+1:] if dirName.startswith(directory) else dirName
 			if subdir:
 				files.append(File.factory(directory,subdir,fname))
+	files.sort(key=lambda f: f.subdir + "/" + f.fileName)
 	outputFile = open(sys.argv[2],"w")
 	print("#include \"resourcemgr.h\"\n",file=outputFile)
 	for f in files:
diff --git a/src/rtfgen.cpp b/src/rtfgen.cpp
index e194777..b4a9e65 100644
--- a/src/rtfgen.cpp
+++ b/src/rtfgen.cpp
@@ -2795,7 +2795,7 @@ void RTFGenerator::exceptionEntry(const char* prefix,bool closeBracket)
 {
   DBG_RTF(t << "{\\comment (exceptionEntry)}"    << endl)
   if (prefix)
-      t << " " << prefix;
+      t << " " << prefix << "(";
   else if (closeBracket)
       t << ")";
   t << " ";
diff --git a/src/xmldocvisitor.cpp b/src/xmldocvisitor.cpp
index 7c31687..525dbf5 100644
--- a/src/xmldocvisitor.cpp
+++ b/src/xmldocvisitor.cpp
@@ -65,7 +65,7 @@ static void visitPreStart(FTextStream &t, const char *cmd, const bool doCaption,
   {
     t << " width=\"" << convertToXML(width) << "\"";
   }
-  else if (!height.isEmpty())
+  if (!height.isEmpty())
   {
     t << " height=\"" << convertToXML(height) << "\"";
   }
diff --git a/testing/005_attention.dox b/testing/005_attention.dox
index c3c390e..90f67f5 100644
--- a/testing/005_attention.dox
+++ b/testing/005_attention.dox
@@ -1,4 +1,4 @@
-// objective: test \attention, \not, \remark, \warning, and \par commands
+// objective: test \attention, \note, \remark, \warning, and \par commands
 // check: indexpage.xml
 /** \mainpage
  *  \attention Attention message.
diff --git a/testing/051/indexpage.xml b/testing/051/indexpage.xml
index 776f525..50a6ff8 100644
--- a/testing/051/indexpage.xml
+++ b/testing/051/indexpage.xml
@@ -6,7 +6,7 @@
     <briefdescription>
     </briefdescription>
     <detaileddescription>
-      <para>Dollar $ At @ Backslash \ Amphasand &amp; Less &lt; Greater &gt; Hash # Percent % Quote " Dot . Double colon :: Pipe | Plus + Minus - </para>
+      <para>Dollar $ At @ Backslash \ Ampersand  &amp; Less &lt; Greater &gt; Hash # Percent % Quote " Dot . Double colon :: Pipe | Plus + Minus - </para>
     </detaileddescription>
   </compounddef>
 </doxygen>
diff --git a/testing/051_escape.dox b/testing/051_escape.dox
index 290b298..2165564 100644
--- a/testing/051_escape.dox
+++ b/testing/051_escape.dox
@@ -5,7 +5,7 @@
 Dollar \$ 
 At \@
 Backslash \\
-Amphasand \&
+Ampersand  \&
 Less \<
 Greater \>
 Hash \#
diff --git a/testing/README.txt b/testing/README.txt
index a5a0ad9..fd7536d 100644
--- a/testing/README.txt
+++ b/testing/README.txt
@@ -1,4 +1,4 @@
-Doxygen regession test suite
+Doxygen regression test suite
 ============================
 
 This directory contains a set of regression tests. Each test consists of a
@@ -7,7 +7,7 @@ has the same 3 digit number. The directory contains one or more reference
 files that are compared against the XML output produced by doxygen. If the
 result is the same, there is no regression and the test passes. If there is a
 difference the test fails and the difference (in diff -u format) will be shown.
-It is also possible to see whether or not the test can be build to a xhtml set
+It is also possible to see whether or not the test can be built to an xhtml set
 of files (and tested against a DTD), it is also possible to create a pdf file
 for each test to see if the LaTeX / pdf generation is possible.
 
@@ -57,4 +57,3 @@ There is also a CMakeLists.txt, which can be used from the build directory
 to run all tests by simply invoking 'make tests', to use the specific options use
 the flag TEST_FLAGS with make
   e.g. make tests TEST_FLAGS="--id=5 --id=10 --pdf --xhtml"
-