Merge branch 'master' into spelling

5 files changed, 25 insertions, 10 deletions

diff --git a/doc/commands.doc b/doc/commands.doc
index 4e0a6f9..9bd3f66 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -2277,8 +2277,8 @@ Commands for displaying examples
   The `option` `lineno` can be used to enable line numbers for the included code if desired.
   The `option` `doc` can be used to treat the file as documentation rather than code.
 
-  \note Some that when using the `{doc}` option,
-       commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with
+  \note When using the `{doc}` option,
+       some commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with
        this command due to the moment of parsing.
 
   \note The included documentation should not have comment signs in it as they will appear
@@ -2409,8 +2409,8 @@ Commands for displaying examples
  The `option` `lineno` can be used to enable line numbers for the included code if desired.
  The `option` `doc` can be used to treat the file as documentation rather than code.
 
- \note Some that when using the `{doc}` option,
-       commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with
+ \note When using the `{doc}` option,
+       some commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with
        this command due to the moment of parsing.
 
  \note The included documentation should not have comment signs in it as they will appear
@@ -2599,7 +2599,7 @@ Commands for visual enhancements
   a Python file for instance, the syntax highlight will be done according
   to the Python syntax. 
 
-  If it unclear from the context which language is meant (for instance the
+  If it is unclear from the context which language is meant (for instance the
   comment is in a <code>.txt</code> or <code>.markdown</code> file) then you can also explicitly
   indicate the language, by putting the file extension typically
   that doxygen associated with the language in curly brackets after the
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index 9d14f6e..8e99669 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -513,6 +513,10 @@ Here is an example VHDL file with doxygen comments:
  for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
  \endlatexonly
 
+As of VHDL 2008 it is also possible to use `/&zwj;*` style comments.
+Doxygen will handle `/&zwj;* ... *&zwj;/`as plain comments and `/&zwj;*! ... *&zwj;/`
+style comments as special comments to be parsed by doxygen.
+
 To get proper looking output you need to set
 \ref cfg_optimize_output_vhdl "OPTIMIZE_OUTPUT_VHDL" to \c YES in the
 configuration file. This will also affect a number of other settings. When they
diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex
index 8ff3c66..e350013 100644
--- a/doc/doxygen_manual.tex
+++ b/doc/doxygen_manual.tex
@@ -66,6 +66,11 @@
 \usepackage{doxygen}
 \usepackage{manual}
 %%
+%gave problems when in doxygen.sty
+\makeatletter
+\newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
+\makeatother
+%%
 % unfortunately constructs like: 
 %   \renewcommand{\doxysection}[1]{\doxysubsection{##1}}
 % using values from book.cls (see also doxygen.sty) and redefining sections to correct level.
diff --git a/doc/extsearch.doc b/doc/extsearch.doc
index ead7ea8..e139408 100644
--- a/doc/extsearch.doc
+++ b/doc/extsearch.doc
@@ -77,7 +77,7 @@ Since we didn't create or install a doxysearch.db it is OK for the test to
 fail for this reason. How to correct this is discussed in the next section.
 
 Before continuing with the next section add the above 
-URL (without the `?test` part) to the `SEARCHENGINE_URL` tag in
+URL (without the `?test` part) to the \ref cfg_searchengine_url "SEARCHENGINE_URL" tag in
 doxygen's configuration file:
 
     SEARCHENGINE_URL = http://yoursite.com/path/to/cgi/doxysearch.cgi
@@ -135,7 +135,8 @@ and then copy the resulting `doxysearch.db` to the directory where also
 
 The `searchdata.xml` file doesn't contain any absolute paths or links, 
 so how can the search results from multiple projects be linked back to the right documentation set?
-This is where the `EXTERNAL_SEARCH_ID` and `EXTRA_SEARCH_MAPPINGS` options come into play.
+This is where the \ref cfg_external_search_id "EXTERNAL_SEARCH_ID" and
+\ref cfg_extra_search_mappings "EXTRA_SEARCH_MAPPINGS" options come into play.
 
 To be able to identify the different projects, one needs to
 set a unique ID using \ref cfg_external_search_id "EXTERNAL_SEARCH_ID"
@@ -168,8 +169,8 @@ and the search results will link to the right documentation set.
 
 When you modify the source code, you should re-run doxygen to get up to date
 documentation again. When using external searching you also need to update the
-search index by re-running `doxyindexer`. You could wrap the call to doxygen
-and doxyindexer together in a script to make this process easier.
+search index by re-running `doxyindexer`. You could wrap the call to `doxygen`
+and `doxyindexer` together in a script to make this process easier.
 
 \section extsearch_api Programming interface
 
diff --git a/doc/markdown.doc b/doc/markdown.doc
index 5edbaf9..883e831 100644
--- a/doc/markdown.doc
+++ b/doc/markdown.doc
@@ -193,10 +193,12 @@ code spans appear inline in a paragraph. An example:
 
     Use the `printf()` function.
 
-To show a literal backtick inside a code span use double backticks, i.e.
+To show a literal backtick or single quote inside a code span use double backticks, i.e.
 
     To assign the output of command `ls` to `var` use ``var=`ls```.
 
+    To assign the text 'text' to `var` use ``var='text'``.
+
 See section \ref mddox_code_spans for more info how doxygen handles
 code spans slightly different than standard Markdown.
 
@@ -606,6 +608,9 @@ In other words; a single quote cancels the special treatment of a code span
 wrapped in a pair of backtick characters. This extra restriction was
 added for backward compatibility reasons.
 
+In case you want to have single quotes inside a code span, don't use 
+one backtick but two backticks around the code span.
+
 \subsection mddox_lists Lists Extensions
 
 With Markdown two lists separated by an empty line are joined together into