Generate documentation
Reported by Martin S. | July 25th, 2009 @ 12:45 PM | in 1.0 Release
We should generate some kind of documentation to the API of libiphone. A couple of functions are already documented with doc comments so this should be straightforward. The candidates probably are doxygen and perhaps gtk-doc (I think the html doc is much easier to read but than it's just a matter of the right conversion templates I guess...).
Comments and changes to this ticket
-
Martin S. July 25th, 2009 @ 04:18 PM
- State changed from “new” to “open”
- Assigned user set to “Matt Colyer”
- Milestone changed from “1.2.0 Release” to “1.0 Release”
Was just experimenting with doxygen and it now generates nice docs for the public interface.
To test just run something along this:[libiphone/]# doxygen doxygen.cfg && firefox docs/html/index.html -
Matt Colyer July 27th, 2009 @ 02:39 AM
I can't get this to apply after I merged libiphone 1.0 api stuff, can you rebase this?
-
Martin S. July 27th, 2009 @ 06:23 AM
It's already in with commit da94f0ebc7232e8e9d0e629fe559b7bc93d9a1c6.
Should we autogenerate the documentation and distribute in make dist and packages correspondingly?Example of the generated docs: http://media.sukimashita.com/temp/libiphone/index.html
-
Matt Colyer July 28th, 2009 @ 03:01 AM
- State changed from “open” to “resolved”
(from [dd97a88597eb00fa688ee9f28cadac117c47f6f0]) Automatically generate documentation for distribution.
[#62 state:resolved] http://github.com/MattColyer/libiphone/commit/dd97a88597eb00fa688ee...
Please Sign in or create a free account to add a new ticket.
With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.
Create new ticket
Create your profile
Help contribute to this project by taking a few moments to create your personal profile. Create your profile ยป
A project around supporting the iPhone in Linux.
See http://libimobiledevice.org
People watching this ticket
Martin S.
Matt Colyer
Attachments
Tags
Referenced by
-
62
Generate documentation
[#62
state:resolved]
http://github.com/MattColyer/libiph...