Dmitri Pal wrote:
Hi,
Patch introduces the capability to generate the documentation for the collection interface.
After installing the patch one can run "make docs" inside collection directory and generate HTML docs and man pages. This patch is a foundation. It is my introduction to doxygen so I am sure it is not perfect.
Please let me know if there are any fundamental issues with it. If they are cosmetic please open trac tasks and I will address them in follow up patches. There are no functional changes other than moving one internal constant from the header into the c module and adding the word const to the argument of one of the functions. I did not hook it into any external targets or global "make XYZ" because I do not know what I am supposed to do with it.
It turned out that the patch was more than 250k. I did not notice that. So here is a compressed one.
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1
On 03/05/2010 05:55 PM, Dmitri Pal wrote:
Dmitri Pal wrote:
Hi,
Patch introduces the capability to generate the documentation for the collection interface.
After installing the patch one can run "make docs" inside collection directory and generate HTML docs and man pages. This patch is a foundation. It is my introduction to doxygen so I am sure it is not perfect.
Please let me know if there are any fundamental issues with it. If they are cosmetic please open trac tasks and I will address them in follow up patches. There are no functional changes other than moving one internal constant from the header into the c module and adding the word const to the argument of one of the functions. I did not hook it into any external targets or global "make XYZ" because I do not know what I am supposed to do with it.
It turned out that the patch was more than 250k. I did not notice that. So here is a compressed one.
Ack. Good work.
I'm sending a follow-up patch to the list to add the documentation into the libcollection-devel package.
- -- Stephen Gallagher RHCE 804006346421761
Delivering value year after year. Red Hat ranks #1 in value among software vendors. http://www.redhat.com/promo/vendor/
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1
On 03/08/2010 12:24 PM, Stephen Gallagher wrote:
On 03/05/2010 05:55 PM, Dmitri Pal wrote:
Dmitri Pal wrote:
Hi,
Patch introduces the capability to generate the documentation for the collection interface.
After installing the patch one can run "make docs" inside collection directory and generate HTML docs and man pages. This patch is a foundation. It is my introduction to doxygen so I am sure it is not perfect.
Please let me know if there are any fundamental issues with it. If they are cosmetic please open trac tasks and I will address them in follow up patches. There are no functional changes other than moving one internal constant from the header into the c module and adding the word const to the argument of one of the functions. I did not hook it into any external targets or global "make XYZ" because I do not know what I am supposed to do with it.
It turned out that the patch was more than 250k. I did not notice that. So here is a compressed one.
Ack. Good work.
I'm sending a follow-up patch to the list to add the documentation into the libcollection-devel package.
Pushed to master and 1-1-0.
- -- Stephen Gallagher RHCE 804006346421761
Delivering value year after year. Red Hat ranks #1 in value among software vendors. http://www.redhat.com/promo/vendor/
sssd-devel@lists.fedorahosted.org
-
Dmitri Pal -
Stephen Gallagher