enhance DefaultSettings.php documentation
authorAntoine Musso <hashar@free.fr>
Tue, 10 Jul 2012 10:59:41 +0000 (12:59 +0200)
committerAntoine Musso <hashar@free.fr>
Sun, 15 Jul 2012 20:03:10 +0000 (22:03 +0200)
commit85c84c27019e84bda96f27bafe47871662f72101
tree9efeae66443c9b65e6699e18e52a992108249917
parent089c58d2327e1c3b260f70bbe4683a36460675a0
enhance DefaultSettings.php documentation

This tweak our doxygen documentation for the DefaultSettings.php. Some
paragraphs were simply reformatted, some received additions.

To nicely render examples, I used the following snippet:

  @par Example:
  @code
  // some code there
  @endcode

That replaces all the <code> occurences.

Replaced some notes and warnings with @note and @warning to output a
nicely formatted box in our HTML documentation.

Change-Id: Iea8d4e46eac2d971af43d47499d121d0c4e2bff3
includes/DefaultSettings.php