pupnp
pupnp copied to clipboard
pupnp
Documentation is missing
On the website it says the generated documentation is included in the sourceforge downloads page, but all the new releases don't include it. It'd be nice to be able to read the docs without taking the time to generate them.
Hi Matthew,
The docs are not very useful right now. There is the file UPnP_Programming_Guide.pdf which is from version 1.2 times but it is not included in the tar ball.
I have just committed a fix that makes it at least possible to generate the docs with make pdf.
There is a lot of doxygen work to do in order to make the automatically generated documentation of any use.
Regards, Marcelo.
Hi what is the issue with doxygen specifically? I was able to generate it just fine the last time I worked on pupnp so it shouldn't be too hard to add?
One issue I have fixed last week was that make pdf was broken.
The other issue I should fix by the end of this week and has to do with the automatic files (templates) that do not get documented. I have it almost working.
Other than that, I would like the docs to be readable and usefull, more on the lines of README.md, even if we copy a lot of its content. Maybe put a \mainfile in upnp.h or some other file and go from there. I believe it would be better some file other than upnp.h so as not to make this file big, since it is the one included externally.
Anyway, the changes I am about to commit do not touch any file currently under git, so if someone wants to make changes do the docs, please feel free to do it.
Best regards, Marcelo.
I would like to integrate pupnp into an application, but without any documentation, it's hard to start. make html and make pdf doesn't work on the current master.
At least the README should be edited saying the current doc (in the tarball in the docs/ folder) is outdated.
