zephyr

Commit Graph

Author	SHA1	Message	Date
Rodrigo Caballero	2dd21c199e	Doc: Edit to the Doxygen guidelines based on feedback. Added a asterisk in front of every line of the comments to fully comply with the Javadoc style. Updated all cross-references to comply with the new style. Added a note indicating explicitly that enums are to be documented just as structs. Change-Id: If017e14e3e478ec28befb5c1fcae92090f91c32e Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>	2016-02-05 20:14:32 -05:00
Rodrigo Caballero	52c116e4ec	Doc: Add the ReST usage guidelines. The guidelines contain how to tag content using the ReST markup employed by Sphinx. Only the project specific rules are supplied. The general syntax is provided by the Sphinx documentation. Examples and templates are provided to make creating documentation easier. Change-Id: If97e1f01de5d4f3de4cad82b7b35279a199433bf Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>	2016-02-05 20:14:27 -05:00

Author

SHA1

Message

Date

Rodrigo Caballero

2dd21c199e

Doc: Edit to the Doxygen guidelines based on feedback.

Added a asterisk in front of every line of the comments to fully comply
with the Javadoc style. Updated all cross-references to comply with the
new style. Added a note indicating explicitly that enums are to be
documented just as structs. 

Change-Id: If017e14e3e478ec28befb5c1fcae92090f91c32e
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>

2016-02-05 20:14:32 -05:00

Rodrigo Caballero

52c116e4ec

Doc: Add the ReST usage guidelines.

The guidelines contain how to tag content using the ReST markup employed
by Sphinx. Only the project specific rules are supplied. The general
syntax is provided by the Sphinx documentation. Examples and templates
are provided to make creating documentation easier.

Change-Id: If97e1f01de5d4f3de4cad82b7b35279a199433bf
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>

2016-02-05 20:14:27 -05:00

2 Commits