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

Sumit Bose sbose at redhat.com
Tue Sep 2 10:46:16 UTC 2014


> > 
> >@@ -408,19 +405,13 @@ enum response_type {
> >  *
> >  * Examples:
> >  *  - #SSS_PAM_USER_INFO_OFFLINE_CHPASS
> >- *    <pre>
> >- *    ----------------------------------
> >- *    | uint32_t | uint32_t | uint32_t |
> >- *    | 0x06     | 0x01     | 0x03     |
> >- *    ----------------------------------
> >- *    </pre>
> >+ *     uint32_t | uint32_t | uint32_t
> >+ *    ----------|----------|----------
> >+ *     0x06     | 0x01     | 0x03
> Here is missing empty line betwen tables.
> See attached image.

I added the line. Strangely for me both versions show the same result.

New version attached.

bye,
Sumit

> 
> >  *  - #SSS_PAM_USER_INFO_CHPASS_ERROR
> >- *    <pre>
> >- *    ----------------------------------------------------------
> >- *    | uint32_t | uint32_t | uint32_t | uint32_t | uint8_t[3] |
> >- *    | 0x06     | 0x05     | 0x04     | 0x03     | abc        |
> >- *    ----------------------------------------------------------
> >- *    </pre>
> >+ *     uint32_t | uint32_t | uint32_t | uint32_t | uint8_t[3]
> >+ *    ----------|----------|----------|----------|------------
> >+ *     0x06     | 0x05     | 0x04     | 0x03     | abc
> >  * @{
> >  */
> 
> Warning is gone.
> Almost ACK
> 
> LS


> _______________________________________________
> sssd-devel mailing list
> sssd-devel at lists.fedorahosted.org
> https://lists.fedorahosted.org/mailman/listinfo/sssd-devel

-------------- next part --------------
From a7c4a20264faece77347ca840ee51b87f2fdc622 Mon Sep 17 00:00:00 2001
From: Sumit Bose <sbose at redhat.com>
Date: Fri, 29 Aug 2014 10:44:00 +0200
Subject: [PATCH] Doxygen: replace <pre> with markdown table

---
 src/sss_client/sss_cli.h | 27 +++++++++------------------
 1 file changed, 9 insertions(+), 18 deletions(-)

diff --git a/src/sss_client/sss_cli.h b/src/sss_client/sss_cli.h
index 16a08e1..7d6d384 100644
--- a/src/sss_client/sss_cli.h
+++ b/src/sss_client/sss_cli.h
@@ -354,12 +354,9 @@ enum sss_status {
  *
  * Examples:
  *  - #SSS_PAM_ENV_ITEM,
- *    <pre>
- *    ------------------------------------
- *    | uint32_t | uint32_t | uint8_t[4] |
- *    | 0x03     | 0x04     | a=b\\0      |
- *    ------------------------------------
- *    </pre>
+       uint32_t | uint32_t | uint8_t[4]
+      ----------|----------|------------
+       0x03     | 0x04     | a=b\\0
  * @{
  */
 
@@ -408,19 +405,13 @@ enum response_type {
  *
  * Examples:
  *  - #SSS_PAM_USER_INFO_OFFLINE_CHPASS
- *    <pre>
- *    ----------------------------------
- *    | uint32_t | uint32_t | uint32_t |
- *    | 0x06     | 0x01     | 0x03     |
- *    ----------------------------------
- *    </pre>
+ *     uint32_t | uint32_t | uint32_t
+ *    ----------|----------|----------
+ *     0x06     | 0x01     | 0x03
  *  - #SSS_PAM_USER_INFO_CHPASS_ERROR
- *    <pre>
- *    ----------------------------------------------------------
- *    | uint32_t | uint32_t | uint32_t | uint32_t | uint8_t[3] |
- *    | 0x06     | 0x05     | 0x04     | 0x03     | abc        |
- *    ----------------------------------------------------------
- *    </pre>
+ *     uint32_t | uint32_t | uint32_t | uint32_t | uint8_t[3]
+ *    ----------|----------|----------|----------|------------
+ *     0x06     | 0x05     | 0x04     | 0x03     | abc
  * @{
  */
 
-- 
1.8.3.1



More information about the sssd-devel mailing list