[SSSD] [PATCH] Doxygen: replace <pre> by \verbatim

Lukas Slebodnik lslebodn at redhat.com
Mon Mar 3 15:00:11 UTC 2014


On (03/03/14 14:53), Sumit Bose wrote:
>and now with a patch ...
>On Mon, Mar 03, 2014 at 02:52:29PM +0100, Sumit Bose wrote:
>> Hi,
>> 
>> this patch should fix a warning while creating the docs and the layout
>> of the docs.
>> 
>> bye,
>> Sumit

>From 5e070d2cb10325563a3de12eaa846710de34d3ef Mon Sep 17 00:00:00 2001
>From: Sumit Bose <sbose at redhat.com>
>Date: Mon, 3 Feb 2014 15:30:56 +0100
>Subject: [PATCH] Doxygen: replace <pre> by \verbatim
>
>---
> src/sss_client/sss_cli.h | 14 +++++++-------
> 1 file changed, 7 insertions(+), 7 deletions(-)
>
>diff --git a/src/sss_client/sss_cli.h b/src/sss_client/sss_cli.h
>index 285a297..dd639b2 100644
>--- a/src/sss_client/sss_cli.h
>+++ b/src/sss_client/sss_cli.h
>@@ -354,12 +354,12 @@ enum sss_status {
>  *
>  * Examples:
>  *  - #SSS_PAM_ENV_ITEM,
>- *    <pre>
>+ *    \verbatim
>  *    ------------------------------------
>  *    | uint32_t | uint32_t | uint8_t[4] |
>- *    | 0x03     | 0x04     | a=b\\0      |
                                         ^^^^^
                                     one more space
>+ *    | 0x03     | 0x04     | a=b\0      |
>  *    ------------------------------------
>- *    </pre>
>+ *    \endverbatim
>  * @{
>  */
> 
>@@ -408,19 +408,19 @@ enum response_type {
>  *
>  * Examples:
>  *  - #SSS_PAM_USER_INFO_OFFLINE_CHPASS
>- *    <pre>
>+ *    \verbatim
>  *    ----------------------------------
>  *    | uint32_t | uint32_t | uint32_t |
>  *    | 0x06     | 0x01     | 0x03     |
>  *    ----------------------------------
  ^^^
All stars between \verbatim , \endverbatim are included in html.
See attached doxygen.png

>- *    </pre>
>+ *    \endverbatim
>  *  - #SSS_PAM_USER_INFO_CHPASS_ERROR
     ^^^
The main problem is that markdown ' - ' is mixed with html tags '<pre>'

>- *    <pre>
>+ *    \verbatim
>  *    ----------------------------------------------------------
>  *    | uint32_t | uint32_t | uint32_t | uint32_t | uint8_t[3] |
>  *    | 0x06     | 0x05     | 0x04     | 0x03     | abc        |
>  *    ----------------------------------------------------------
>- *    </pre>
>+ *    \endverbatim
>  * @{
>  */

There are few possible solutions:
    - use only markdown in one comment (http://www.doxygen.nl/markdown.html)
    - use only html tags in one comment

--- a/src/sss_client/sss_cli.h
+++ b/src/sss_client/sss_cli.h
@@ -407,20 +407,22 @@ enum response_type {
  * 32-bit integer value and optional data.
  *
  * Examples:
- *  - #SSS_PAM_USER_INFO_OFFLINE_CHPASS
+ * <ul>
+ * <li> #SSS_PAM_USER_INFO_OFFLINE_CHPASS </li>
  *    <pre>
  *    ----------------------------------
  *    | uint32_t | uint32_t | uint32_t |
  *    | 0x06     | 0x01     | 0x03     |
  *    ----------------------------------
  *    </pre>
- *  - #SSS_PAM_USER_INFO_CHPASS_ERROR
+ * <li> #SSS_PAM_USER_INFO_CHPASS_ERROR </li>
  *    <pre>
  *    ----------------------------------------------------------
  *    | uint32_t | uint32_t | uint32_t | uint32_t | uint8_t[3] |
  *    | 0x06     | 0x05     | 0x04     | 0x03     | abc        |
  *    ----------------------------------------------------------
  *    </pre>
+ * </ul>
  * @{
  */

LS
-------------- next part --------------
A non-text attachment was scrubbed...
Name: doxygen.png
Type: image/png
Size: 21599 bytes
Desc: not available
URL: <https://lists.fedorahosted.org/pipermail/sssd-devel/attachments/20140303/e44fa6d1/attachment.png>


More information about the sssd-devel mailing list