[patch] ldb docs update
Stefan (metze) Metzmacher
metze at samba.org
Mon Jan 9 13:17:52 GMT 2006
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Brad Hards schrieb:
> This patch is an interim step towards providing reasonably complete API
> documentation for ldb. If you apply this patch, and run "doxygen" in the top
> level ldb directory, then you will get html and man pages for the API as I
> understand it.
>
> The reason for using doxygen is that it has native C support, so things like
> example code get correctly linked to and from the applicable ldb functions.
>
> Almost certainly, there are some errors. It is also incomplete. Feel free to
> correct either or both. My only justification for writing this is that I need
> to read it...
>
> I do intend to do more work on this, but this patch serves as a backup in case
> my machine dies. It might even be worth merging.
>
> Brad
> struct ldb_ldif {
> - enum ldb_changetype changetype;
> - struct ldb_message *msg;
> + enum ldb_changetype changetype; ///< The type of change
> + struct ldb_message *msg; ///< The changes
> };
we can't use c++ style comments as some compilers don't like them,
is it possible to change the '///' into a '/*...*/' combination?
btw: the output looks very nice.
- --
metze
Stefan Metzmacher <metze at samba.org> www.samba.org
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3-nr1 (Windows XP)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
iD8DBQFDwmJ+m70gjA5TCD8RAsJ8AKChTIGpVbtRhI1D8sT/HUKPH7L03ACdH9um
oirb/TJj1en0pRkYBEiES6M=
=kA7k
-----END PGP SIGNATURE-----
More information about the samba-technical
mailing list