All of lore.kernel.org
 help / color / mirror / Atom feed
From: Anna-Maria Behnsen <anna-maria@linutronix.de>
To: linux-doc@vger.kernel.org
Subject: Help required - kernel-doc, code block and backslash
Date: Mon, 15 Jan 2024 19:36:46 +0100	[thread overview]
Message-ID: <87y1cqbg01.fsf@somnus> (raw)

Hi,

I'll try to integrate some documentation which is already written in
code comments into the kernel documentation.

There I face the problem with a backslash at the end of a line in a
'code block' and this ends up in removing the newline.

So I have this comment in code and I simply want to use the kernel-doc
'doc' option to integrate it into documentation:

/**
 * DOC: example
 *
 * This should illustrate a hierarchy as a code block::
 *
 *                    Top Level
 *                /               \
 *        Parent A                 Parent B
 *       /        \               /        \
 *  Child A      Child B       Child C   Child D
 *
 */

And the code block looks like this after using the make target
'htmldocs':

             Top Level
         /                *        parent A                 parent B
/        \               /         *  Child A      Child B       Child C   Child D


I wonder, if there is something broken (as the * of the c comment is in
there again)?

Another question: Is there an linux-doc irc channel to ask simple
questions?

Thanks,
	Anna-Maria


             reply	other threads:[~2024-01-15 18:36 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-15 18:36 Anna-Maria Behnsen [this message]
2024-01-15 19:38 ` Help required - kernel-doc, code block and backslash Jonathan Corbet
2024-01-15 20:16   ` Matthew Wilcox
2024-01-16  9:53     ` Anna-Maria Behnsen
2024-01-15 20:35   ` Vegard Nossum
2024-01-16 16:55   ` Anna-Maria Behnsen
2024-01-16 18:28     ` Jonathan Corbet
2024-01-17 11:19       ` Anna-Maria Behnsen
2024-01-17 15:22         ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87y1cqbg01.fsf@somnus \
    --to=anna-maria@linutronix.de \
    --cc=linux-doc@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.