Hi,
this patch should fix a warning while creating the docs and the layout of the docs.
bye, Sumit
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@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
On (03/03/14 16:00), Lukas Slebodnik wrote:
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@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
bump :-)
LS
On Thu, Aug 28, 2014 at 10:33:42AM +0200, Lukas Slebodnik wrote:
On (03/03/14 16:00), Lukas Slebodnik wrote:
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@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
bump :-)
Thank you for the reminder :-)
I prefer markdown and the new patch uses markdown tables.
bye, Sumit
LS _______________________________________________ sssd-devel mailing list sssd-devel@lists.fedorahosted.org https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
On (29/08/14 11:07), Sumit Bose wrote:
On Thu, Aug 28, 2014 at 10:33:42AM +0200, Lukas Slebodnik wrote:
On (03/03/14 16:00), Lukas Slebodnik wrote:
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@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
bump :-)
Thank you for the reminder :-)
I prefer markdown and the new patch uses markdown tables.
bye, Sumit
LS _______________________________________________ sssd-devel mailing list sssd-devel@lists.fedorahosted.org https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
From 9461a77114389a34867d1015cb230f954297d531 Mon Sep 17 00:00:00 2001 From: Sumit Bose sbose@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
Here is missing empty line betwen tables. See attached image.
- #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
@@ -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@lists.fedorahosted.org https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
On Tue, Sep 02, 2014 at 12:46:16PM +0200, Sumit Bose wrote:
@@ -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.
sorry, I accidentally send the old version.
bye, Sumit
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@lists.fedorahosted.org https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
From a7c4a20264faece77347ca840ee51b87f2fdc622 Mon Sep 17 00:00:00 2001 From: Sumit Bose sbose@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
sssd-devel mailing list sssd-devel@lists.fedorahosted.org https://lists.fedorahosted.org/mailman/listinfo/sssd-devel
On (02/09/14 12:53), Sumit Bose wrote:
On Tue, Sep 02, 2014 at 12:46:16PM +0200, Sumit Bose wrote:
@@ -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.
From fe97cdc247c8b8cd468397c628e61dbd27121e09 Mon Sep 17 00:00:00 2001 From: Sumit Bose sbose@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 | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-)
diff --git a/src/sss_client/sss_cli.h b/src/sss_client/sss_cli.h index 16a08e1..a0c635f 100644
Thank you ver much. Warning is gone.
ACK
LS
On Tue, Sep 02, 2014 at 01:17:13PM +0200, Lukas Slebodnik wrote:
From fe97cdc247c8b8cd468397c628e61dbd27121e09 Mon Sep 17 00:00:00 2001 From: Sumit Bose sbose@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 | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-)
diff --git a/src/sss_client/sss_cli.h b/src/sss_client/sss_cli.h index 16a08e1..a0c635f 100644
Thank you ver much. Warning is gone.
ACK
LS
* master: 316ff9ad6f959443ddadd54e9fe9ebf6c8052214
sssd-devel@lists.fedorahosted.org