Skip to content

Commit

Permalink
chapter 12 abstracts
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Sep 18, 2018
1 parent 7be78ac commit 84b0fd3
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 3 deletions.
7 changes: 6 additions & 1 deletion chapter-12/recipe-01/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Building documentation using Doxygen

Abstract to be written ...
[Doxygen](http://www.doxygen.nl) is a popular source code documentation tool in
the C++ community. Running Doxygen will extract comments which contain
documentation tags and create the documentation in a format defined in the
Doxyfile configuration file (HTML, XML, and even LaTeX or PDF). This recipe
shows how to use CMake to build your Doxygen documentation.


- [cxx-example](cxx-example/)
5 changes: 5 additions & 0 deletions chapter-12/recipe-01/abstract.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[Doxygen](http://www.doxygen.nl) is a popular source code documentation tool in
the C++ community. Running Doxygen will extract comments which contain
documentation tags and create the documentation in a format defined in the
Doxyfile configuration file (HTML, XML, and even LaTeX or PDF). This recipe
shows how to use CMake to build your Doxygen documentation.
7 changes: 6 additions & 1 deletion chapter-12/recipe-02/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Building documentation using Sphinx

Abstract to be written ...
[Sphinx](http://www.sphinx-doc.org) can parse reStructuredText, Markdown
plain-text files, and generate HTML, ePUB, or PDF documentation. Coupled with the
online [Read the Docs](https://readthedocs.org) service, it offers a great way to quickly
get started with writing and deploying documentation. This recipe shows how to
use CMake to build documentation based on Sphinx.


- [cxx-example](cxx-example/)
5 changes: 5 additions & 0 deletions chapter-12/recipe-02/abstract.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[Sphinx](http://www.sphinx-doc.org) can parse reStructuredText, Markdown
plain-text files, and generate HTML, ePUB, or PDF documentation. Coupled with the
online [Read the Docs](https://readthedocs.org) service, it offers a great way to quickly
get started with writing and deploying documentation. This recipe shows how to
use CMake to build documentation based on Sphinx.
6 changes: 5 additions & 1 deletion chapter-12/recipe-03/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Combining Doxygen and Sphinx

Abstract to be written ...
This recipe illustrates
how to use the [Breathe](https://breathe.readthedocs.io) plugin in combination with CMake
to bridge [Doxygen](http://www.doxygen.nl) and
[Sphinx](http://www.sphinx-doc.org).


- [cxx-example](cxx-example/)
4 changes: 4 additions & 0 deletions chapter-12/recipe-03/abstract.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
This recipe illustrates
how to use the [Breathe](https://breathe.readthedocs.io) plugin in combination with CMake
to bridge [Doxygen](http://www.doxygen.nl) and
[Sphinx](http://www.sphinx-doc.org).

0 comments on commit 84b0fd3

Please sign in to comment.