From: Yao Qi <yao@codesourcery.com>
To: Doug Evans <dje@google.com>
Cc: Eli Zaretskii <eliz@gnu.org>,
Stan Shebs <stanshebs@earthlink.net>, gdb <gdb@sourceware.org>
Subject: Re: A new strategy for internals documentation
Date: Sat, 10 Aug 2013 01:13:00 -0000 [thread overview]
Message-ID: <52059367.3040300@codesourcery.com> (raw)
In-Reply-To: <CADPb22QNbWQhPGQ2Utfh=C+hFH5iJMrR30G=BE646Z87R_1Yfg@mail.gmail.com>
On 08/09/2013 07:04 AM, Doug Evans wrote:
> I'm one that thinks that there is not enough, and that expanding the
> comments is not enough. For one there's a higher level / descriptive
> view that's missing with that approach. Plus the S/N ratio when faced
> with reading all the source code is much lower than when able to
> browse something generated from the comments in the code.
Code comments can be about high-level view too. Existing comments in
the beginning of event-loop.h and remote-notif.c are about high-level
view.
Document is generated from the comments, and we need some special
annotations or markups to identify these comments are descriptive views
for a certain module or components. Doxygen or other documentation
generators are able to do that.
--
Yao (é½å°§)
next prev parent reply other threads:[~2013-08-10 1:13 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-08-06 22:26 Stan Shebs
2013-08-07 4:28 ` Eli Zaretskii
2013-08-07 19:58 ` Stan Shebs
2013-08-08 17:28 ` Eli Zaretskii
2013-08-08 21:08 ` Doug Evans
2013-08-08 21:56 ` Eli Zaretskii
2013-08-08 23:03 ` Stan Shebs
2013-08-09 8:08 ` John Gilmore
2013-08-09 9:53 ` Eli Zaretskii
2013-08-09 9:35 ` Eli Zaretskii
2013-08-09 23:04 ` Stan Shebs
2013-08-09 9:53 ` Mark Kettenis
2013-08-09 23:28 ` Stan Shebs
2013-08-08 23:04 ` Doug Evans
2013-08-09 9:13 ` Eli Zaretskii
2013-08-10 1:13 ` Yao Qi [this message]
2013-08-21 18:09 ` Steinar Bang
2013-08-21 20:02 ` Eli Zaretskii
2013-08-22 18:29 ` Steinar Bang
2013-08-08 3:45 ` Yao Qi
2013-08-08 17:31 ` Eli Zaretskii
2013-08-09 1:30 ` John Gilmore
2013-08-09 9:26 ` Eli Zaretskii
2013-08-09 18:16 ` Tom Tromey
2013-08-09 18:36 ` Eli Zaretskii
2013-08-09 22:31 ` Stan Shebs
2013-08-09 23:32 ` Matt Rice
2013-08-10 2:24 ` John Gilmore
2013-08-08 20:43 ` Tom Tromey
2013-08-08 20:57 ` Doug Evans
2013-08-08 20:41 ` Tom Tromey
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=52059367.3040300@codesourcery.com \
--to=yao@codesourcery.com \
--cc=dje@google.com \
--cc=eliz@gnu.org \
--cc=gdb@sourceware.org \
--cc=stanshebs@earthlink.net \
/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