- Status New
- Percent Complete
- Task Type Feature Request
- Category Documentation
- Assigned To No-one
- Operating System All
- Severity Low
- Priority Very Low
- Reported Version 2.33
- Due in Version Undecided
-
Due Date
Undecided
- Votes
- Private
FS#297 - In code documentation for PHP-Documentor or Doxygen
It would be great if PO could make use of automated documentation tools such as Doxygen or PHP-Documentor.
It is now a time consuming task to start understanding the inner workings of PO as you need both an overview of the database schema and the logic in the code.
With a bit more documentation about the files and the routines in PO solving bugs or contributing code will become much easier.
Loading...
Available keyboard shortcuts
- Alt + ⇧ Shift + l Login Dialog / Logout
- Alt + ⇧ Shift + a Add new task
- Alt + ⇧ Shift + m My searches
- Alt + ⇧ Shift + t focus taskid search
Tasklist
- o open selected task
- j move cursor down
- k move cursor up
Task Details
- n Next task
- p Previous task
- Alt + ⇧ Shift + e ↵ Enter Edit this task
- Alt + ⇧ Shift + w watch task
- Alt + ⇧ Shift + y Close Task
Task Editing
- Alt + ⇧ Shift + s save task
It's a good idea, but unfortunately there's not much to document. PO effectively is a bunch of scripts that makes use of a pile of shared library functions.
I agree that what's there needs to be better documented. I'll see what PHP-Documentor has to offer. Doxygen I've used a bit already. :)