From: Zongchun YU <b40527@freescale.com>
To: "'Burton, Ross'" <ross.burton@intel.com>
Cc: 'OE-core' <openembedded-core@lists.openembedded.org>
Subject: Re: [PATCH 2/2] Add api-doc class
Date: Mon, 19 May 2014 11:18:57 +0800 [thread overview]
Message-ID: <003001cf7311$13ceec40$3b6cc4c0$@com> (raw)
In-Reply-To: <CAJTo0LavgOS4HyXLB2ur6PsH3yAaWW7SQf5qFcoz1yia_uMfqA@mail.gmail.com>
>It's not opt-in: once a recipe is using doxygen.bbclass then it has a build dependency on doxygen-native and *will* generate documentation.
>This is needless overhead if you don't intend to read the documentation.
I think if you intend to read the documentation. Just inherit this class. If not. there is no need to inherit this class.
>You can't assert that the documentation is solely generated on the shipped files in the tarballs: what if some of the files are machine-generated? Or if with for example DBus, the doxygen is generated?
>I've nothing against a doxygen class and would like to also see a gtk-doc class that isn't a stub, with a single distribution-level "generate API documentation" variable controlling them. But the documentation has to be generated at build time, and I think it's fair to assume that is a package has API documentation then "make" will build it, otherwise the method to build the documentation will be different for every package.
>For example, DBus has a Doxyfile.in at the top of the source tree, so not only does configure needs to run to generate a Doxyfile but that Doxyfile is written to ${B}, not ${S}.
OK. You are right. What about configure task? Maybe we should adjust this task before it. Doxyfile(or other name) is the file which will be used by doxygen. It is one part of source code to be maintain.
Zongchun
next prev parent reply other threads:[~2014-05-19 3:18 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-05-16 7:45 [PATCH 2/2] Add api-doc class b40527
2014-05-16 9:39 ` Burton, Ross
2014-05-16 10:18 ` Zongchun YU
2014-05-16 10:34 ` Burton, Ross
2014-05-19 3:18 ` Zongchun YU [this message]
2014-05-19 9:46 ` Burton, Ross
2014-05-23 5:45 ` Zongchun YU
2014-05-23 9:37 ` Burton, Ross
-- strict thread matches above, loose matches on Subject: below --
2014-05-16 9:01 b40527
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='003001cf7311$13ceec40$3b6cc4c0$@com' \
--to=b40527@freescale.com \
--cc=openembedded-core@lists.openembedded.org \
--cc=ross.burton@intel.com \
/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.