From: Markus Elfring <Markus.Elfring@web.de>
To: Enrico Weigelt <lkml@metux.net>,
"Theodore Y. Ts'o" <tytso@mit.edu>,
linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org
Cc: LKML <linux-kernel@vger.kernel.org>
Subject: Re: Improving documentation for programming interfaces
Date: Wed, 8 Jan 2020 13:40:45 +0100 [thread overview]
Message-ID: <748b8572-a3b3-c084-e8e3-de420f53e468@web.de> (raw)
In-Reply-To: <17931ddd-76ec-d342-912c-faed6084e863@metux.net>
> hmm, maybe we could add some kinda-OOP-style metadata into the type documentation ?
I hope so.
> Or maybe extend doxygen to crossref types vs functions operating on them.
An advanced cross-reference variant would be nice (besides the “Elixir”).
>>> It seems that no customised attributes are supported at the moment.
>>> Thus I imagine to specify helpful annotations as macros.
>
> Do you mean _attribute__(...) or comments ?
I propose to encode helpful information into macro calls as needed
for the C programming language.
> I guess he's thinking about some kind of meta-language for expressing
> common things we know from oop-world, like ctors, dtors, getters, etc.
This feedback fits also to my imaginations for a better taxonomy.
Regards,
Markus
next prev parent reply other threads:[~2020-01-08 12:41 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-20 13:30 Improving documentation for programming interfaces Markus Elfring
2019-12-20 15:19 ` Theodore Y. Ts'o
2019-12-20 16:23 ` Markus Elfring
2019-12-20 17:17 ` Theodore Y. Ts'o
2019-12-20 18:00 ` Markus Elfring
2020-01-08 12:04 ` Enrico Weigelt, metux IT consult
2020-01-08 12:40 ` Markus Elfring [this message]
2020-01-08 16:14 ` Theodore Y. Ts'o
2020-01-08 16:55 ` Markus Elfring
2020-05-01 7:20 ` Markus Elfring
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=748b8572-a3b3-c084-e8e3-de420f53e468@web.de \
--to=markus.elfring@web.de \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkml@metux.net \
--cc=tytso@mit.edu \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).