Re: [libvirt] Suggestions on how to add "Available from version: 0.x.x"?
On 07/10/2010 03:27 PM, Justin Clift wrote:
Looking at our present API docs though, they seem to be
autogenerated,
so I'm no sure how to approach this.
My initial thinking is maybe having the list of each function per
version in a separate (text?) file, and then somehow pull that info in.
We already have one file that lists when each API was added
(src/libvirt_public.syms).
But, not even sure that will work.
Anyone have ideas?
Hmm - our autogenerated docs are already modeled after doxygen/javadoc
style comments. Doesn't javadoc support the @since tag? If that is the
case, it would be pretty easy to document @since alongside all the other
comments that turn into the autogenerated text, and much easier to
maintain in contrast to any solution which requires maintaining multiple
files when adding a new API.
--
Eric Blake eblake(a)redhat.com +1-801-349-2682
Libvirt virtualization library http://libvirt.org
Attachments:
- signature.asc (application/pgp-signature — 619 bytes)