import quincy beta 17.1.0

[ceph.git] / ceph / doc / dev / documenting.rst

diff --git a/ceph/doc/dev/documenting.rst b/ceph/doc/dev/documenting.rst
index 42bd56d06fed5754d55090445efaf1c1d5d810d1..e6c05ee2a44ff096fe49ab31f97faba3bc216d9b 100644 (file)
--- a/ceph/doc/dev/documenting.rst
+++ b/ceph/doc/dev/documenting.rst
@@ -5,7 +5,7 @@
 User documentation
 ==================
 
-The documentation on docs.ceph.com is generated from the restructuredText
+The documentation on docs.ceph.com is generated from the reStructuredText
 sources in ``/doc/`` in the Ceph git repository.
 
 Please make sure that your changes are written in a way that is intended
@@ -33,7 +33,9 @@ markup supported by Breathe_.
 .. _Doxygen: http://www.doxygen.nl/
 .. _Breathe: https://github.com/michaeljones/breathe
 
-The general format for function documentation is::
+The general format for function documentation is
+
+.. code-block:: c
 
   /**
    * Short description
@@ -55,7 +57,7 @@ To generate the doxygen documentation in HTML format use:
 
 ::
 
-   # make doxygen
+   # cmake --build . --target doxygen
 
 HTML output will be under: ``build-doc/doxygen/html``