Added cmake rules to build the examples that are also part of the manual

BUILD.txt

@@ -30,7 +30,6 @@ Doxygen's cmake configuration provides a number of options:
 - build_xmlparser Example showing how to parse doxygen's XML output.
 - build_search    Build external search tools (doxysearch and doxyindexer).
 - build_doc       Build user manual.
-- build_examples  Build the example projects.
 - use_sqlite3     Add support for sqlite3 output [experimental].
 - use_libclang    Add support for libclang parsing.
 - win_static      Link with /MT in stead of /MD on windows.

CMakeLists.txt

@@ -19,7 +19,6 @@ option(build_app       "Example showing how to embed doxygen in an application."
 option(build_xmlparser "Example showing how to parse doxygen's XML output." OFF)
 option(build_search    "Build external search tools (doxysearch and doxyindexer)" OFF)
 option(build_doc       "Build user manual" OFF)
-option(build_examples  "Build the example projects" OFF)
 option(use_sqlite3     "Add support for sqlite3 output [experimental]." OFF)
 option(use_libclang    "Add support for libclang parsing." OFF)
 option(win_static      "Link with /MT in stead of /MD on windows" OFF)

doc/CMakeLists.txt

@@ -27,7 +27,7 @@ add_custom_target(docs
 	COMMAND ${SED} -e "s/\$VERSION/${VERSION}/g" doxygen.sty > ../latex/doxygen.sty
 	COMMAND ${EPSTOPDF} doxygen_logo.eps --outfile=../latex/doxygen_logo.pdf
         COMMAND ${MAKE} -C ../latex > latex_out.txt
-	DEPENDS doxygen ${PROJECT_BINARY_DIR}/doc/language.doc config.doc
+	DEPENDS doxygen ${PROJECT_BINARY_DIR}/doc/language.doc config.doc examples
                 "${PROJECT_BINARY_DIR}/man/doxygen.1"
                 "${PROJECT_BINARY_DIR}/man/doxywizard.1"
                 "${PROJECT_BINARY_DIR}/man/doxysearch.1"
@@ -91,7 +91,6 @@ install(FILES
 )
 
 install(DIRECTORY
-        "${PROJECT_BINARY_DIR}/examples"
         "${PROJECT_BINARY_DIR}/html"
         DESTINATION "${CMAKE_INSTALL_PREFIX}/${DOC_INSTALL_DIR}"
 )

doc/autolink.doc

@@ -112,7 +112,7 @@
   \par Example:
   \verbinclude autolink.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/autolink/html/index.html">here</a> 
+  Click <a href="examples/autolink/html/index.html">here</a> 
   for the corresponding HTML documentation that is generated by Doxygen.
   \endhtmlonly
 
@@ -128,7 +128,7 @@ typedef struct StructName TypeName
   \par Example:
   \verbinclude restypedef.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/restypedef/html/restypedef_8cpp.html">here</a> 
+  Click <a href="examples/restypedef/html/restypedef_8cpp.html">here</a> 
   for the corresponding HTML documentation that is generated by Doxygen.
   \endhtmlonly
 

doc/commands.doc

@@ -360,7 +360,7 @@ Structural indicators
   \par Example:
   \verbinclude class.h
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/class/html/index.html">here</a>
+  Click <a href="examples/class/html/index.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -374,7 +374,7 @@ Structural indicators
   \par Example:
   \verbinclude define.h
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define_8h.html">here</a>
+  Click <a href="examples/define/html/define_8h.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -422,7 +422,7 @@ Structural indicators
   \par Example:
   \verbinclude enum.h
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/enum/html/class_test.html">here</a>
+  Click <a href="examples/enum/html/class_test.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -453,7 +453,7 @@ Structural indicators
   Where the example file \c example_test.cpp looks as follows:
   \verbinclude example_test.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/example/html/examples.html">here</a>
+  Click <a href="examples/example/html/examples.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -479,7 +479,7 @@ Structural indicators
   The file \c manual.c in the example directory shows how to use this command.
 
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a>
+  Click <a href="examples/manual/html/index.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -503,7 +503,7 @@ Structural indicators
   \par Example:
   \verbinclude file.h
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file_8h.html">here</a>
+  Click <a href="examples/file/html/file_8h.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -537,7 +537,7 @@ Structural indicators
   \par Example:
   \verbinclude func.h
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/func/html/class_test.html">here</a>
+  Click <a href="examples/func/html/class_test.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -619,7 +619,7 @@ Structural indicators
   The file \c manual.c in the example directory shows how to use this command.
 
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a>
+  Click <a href="examples/manual/html/index.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -719,7 +719,7 @@ Structural indicators
   The file \c manual.c in the example directory shows how to use this command.
 
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a>
+  Click <a href="examples/manual/html/index.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -787,7 +787,7 @@ Structural indicators
   \par Example:
   \verbinclude examples/overload.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/overload/html/class_test.html">here</a>
+  Click <a href="examples/overload/html/class_test.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -811,7 +811,7 @@ Structural indicators
   \par Example:
   \verbinclude page.doc
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/page/html/pages.html">here</a>
+  Click <a href="examples/page/html/pages.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -967,7 +967,7 @@ Structural indicators
   \par Example:
   \verbinclude relates.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/relates/html/class_string.html">here</a>
+  Click <a href="examples/relates/html/class_string.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -1118,7 +1118,7 @@ Section indicators
   \par Example:
   \verbinclude author.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/author/html/class_some_nice_class.html">here</a>
+  Click <a href="examples/author/html/class_some_nice_class.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -1461,7 +1461,7 @@ ALIASES  = "english=\if english" \
   \par Example:
   \verbinclude par.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/par/html/class_test.html">here</a>
+  Click <a href="examples/par/html/class_test.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 
@@ -2067,7 +2067,7 @@ Commands for displaying examples
   Where the example file \c example_test.cpp looks as follows:
   \verbinclude example_test.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/include/html/example.html">here</a>
+  Click <a href="examples/include/html/example.html">here</a>
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
 

doc/diagrams.doc

@@ -138,7 +138,7 @@ that doxygen can generate:
 \verbinclude diagrams_e.h
 
 \htmlonly
-Click <a href="$(DOXYGEN_DOCDIR)/examples/diagrams/html/index.html">here</a>
+Click <a href="examples/diagrams/html/index.html">here</a>
 for the corresponding HTML documentation that is generated by doxygen<br/>
 (<code>EXTRACT_ALL</code> = <code>YES</code> is used here).
 \endhtmlonly

doc/docblocks.doc

@@ -259,7 +259,7 @@ located in front of the block instead of after the block.
 Here is an example of the use of these comment blocks:
 \include afterdoc.h
  \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/afterdoc/html/class_test.html">here</a>
+ Click <a href="examples/afterdoc/html/class_test.html">here</a>
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly
 
@@ -275,7 +275,7 @@ Here is an example of the use of these comment blocks:
 Here is an example of a documented piece of C++ code using the Qt style:
 \include qtstyle.cpp
  \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/qtstyle/html/class_test.html">here</a>
+ Click <a href="examples/qtstyle/html/class_test.html">here</a>
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly
 
@@ -305,7 +305,7 @@ Here is the same piece of code as shown above, this time documented using the
 JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES:
 \include jdstyle.cpp
  \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/jdstyle/html/class_test.html">here</a>
+ Click <a href="examples/jdstyle/html/class_test.html">here</a>
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly
 
@@ -381,7 +381,7 @@ Here is an example of a C header named \c structcmd.h that is documented
 using structural commands:
 \include structcmd.h
  \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/structcmd/html/structcmd_8h.html">here</a>
+ Click <a href="examples/structcmd/html/structcmd_8h.html">here</a>
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly
 
@@ -421,7 +421,7 @@ and assume they have to be represented in a preformatted way.
 
 \include docstring.py
  \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/docstring/html/index.html">here</a>
+ Click <a href="examples/docstring/html/index.html">here</a>
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly
 
@@ -437,7 +437,7 @@ Here is the same example again but now using doxygen style comments:
 
 \include pyexample.py
  \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/pyexample/html/index.html">here</a>
+ Click <a href="examples/pyexample/html/index.html">here</a>
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly
 
@@ -462,7 +462,7 @@ Here is an example VHDL file with doxygen comments:
 
 \include  mux.vhdl
  \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/mux/html/index.html">here</a>
+ Click <a href="examples/mux/html/index.html">here</a>
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly
 
@@ -571,7 +571,7 @@ Following is an example using doxygen style comments:
 
 \include tclexample.tcl
  \htmlonly
- Click <a href="$(DOXYGEN_DOCDIR)/examples/tclexample/html/index.html">here</a>
+ Click <a href="examples/tclexample/html/index.html">here</a>
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly