Messages in this thread | | | Subject | Re: [PATCH] kernel-doc: better handle '::' sequences | From | Markus Heiser <> | Date | Tue, 30 Mar 2021 14:43:45 +0200 |
| |
Am 30.03.21 um 13:35 schrieb Jani Nikula: >> If the introduction were "/*rST" instead of "/**", would we have >> consensus? It gives us a path to let people intermix kernel-doc and >> hawkmoth comments in the same file, which would be amazing.
> If you want to allow two syntaxes for documentation comments (current > kernel-doc and pure reStructuredText with just the comment markers and > indentation removed) I think the natural first step would be to modify > kernel-doc the perl script to support that. It would probably even be > trivial.
My 2cent: to tag the markup of the documentation, in python they use a variable named __docformat__ [PEP-258] / e.g.:
__docformat__ = "restructuredtext en"
[PEP-258] https://www.python.org/dev/peps/pep-0258/#choice-of-docstring-format
> Perhaps the bare minimum is running rustdoc first, and generating the > results into Sphinx static pages [1], to make them part of the > whole. Even if the HTML style might be different.
Cross referencing will be problematic, I think.
-- Markus --
| |