.. _doxygen-instructions:

********************
Doxygen Instructions
********************

This section contains instructions on how to use
`Doxygen <http://www.stack.nl/~dimitri/doxygen/>`_ with Drake.

.. _doxygen-style-guide:

Doxygen Style Guide
===================

Coming soon. See issue
`#2051 <https://github.com/RobotLocomotion/drake/issues/2051>`_ and PR
`#2359 <https://github.com/RobotLocomotion/drake/pull/2359>`_.


Documentation Tips and Tricks
=============================

We encourage the use of `unicode <unicode_tips_tricks>`_ in documentation.

For documenting block diagrams, consider using ascii art.  See, for instance,

- http://asciiflow.com/


.. _doxygen-generation:

Doxygen Website Generation
==========================

To generate and view Drake's Doxygen website, see:
:ref:`Documentation Instructions<documentation-generation-instructions>`.
