Forums : Feedback Forum
Dear Open Hub Users,
We’re excited to announce that we will be moving the Open Hub Forum to
https://community.blackduck.com/s/black-duck-open-hub.
Beginning immediately, users can head over,
register,
get technical help and discuss issue pertinent to the Open Hub. Registered users can also subscribe to Open Hub announcements here.
On May 1, 2020, we will be freezing https://www.openhub.net/forums and users will not be able to create new discussions. If you have any questions and concerns, please email us at
[email protected]
code documentation
We are currently documenting all the code of WikkaWiki using phpDocumentor docblocks, it would be nice if Ohloh was able to detect projects containing structured documentation as opposed to simple inline comments (and maybe distinguish the two in the codebase history graph).
If this is feasible, you may also want to give project maintainers the possibility to add a link to compiled, human-readable code documentation.
bumping this because no one reacted�is this because of lack of interest for this feature request or for the complexity of its implementation in terms of code parsing? I'd like to hear from others on this.
It's a good idea. Some sort of analysis of documentation comments would be cool.
thanks for the bump, dartar - exactly what this needed!
General Project Help/Docs Links
You're reading our minds! We're close to adding a new Ohloh feature soon: project links. Basically anyone will be able to add links related to a project (ie: tutorials, manuals, forums, etc...).
Structured Documentations
Ohloh doesn't currently 'understand' comments - we just count them up. I can think of 2 features if we were to start 'understand' them. Namely:
Show the structured documentation metrics: basically - we could treat it as a comment 'language'. Just like code has languages (C, Java, etc..), comments could also have 'languages' (we'd call them something else - types? flavors?). Examples of these would be: phpDocumentor, javaDoc, RDoc (ruby), etc...
parse the comments appropriately, generate the resulting documentation and re-host it.
I assume you're hoping for the metrics part (if not the hosting of the docs). Let me know if there's any other ideas around this and if I understood you clearly. Thanks!
Hi Jason, and thanks for your reply, I was actually referring to the metrics part, since I assume every project hosts its own code documentation so there's no need to replicate this.
We're close to adding a new Ohloh feature soon: project links.
Jason, I see they are live�cool.
May I suggest a few more categories?
- Developer documentation (i.e. self-compiled docs from the code)
- Demo
- Code repository (SVN or CVS)
- Bug tracker
Hi Dario,
Great suggestions. I'll give the links feature a few days to bake, then I'll add the categories you suggested. Thanks!