#5910: A simple Doxyfile fix for Doxygen and the API docs
------------------------+---------------------------------------------------
Reporter: ramaboo | Type: Documentation
Status: new | Priority: Medium
Milestone: 1.2.x.x | Component: Documentation
Version: RC4 | Severity: Normal
Keywords: | Php_version: n/a
Cake_version: |
------------------------+---------------------------------------------------
In the Doxygen file used to generate the API docs for api.cakephp.org
there is an option called JAVADOC_AUTOBRIEF see:
http://www.stack.nl/~dimitri/doxygen/config.html#cfg_javadoc_autobrief
You have this set to: JAVADOC_AUTOBRIEF = NO
It should be JAVADOC_AUTOBRIEF = YES
If you set it to YES then it will take the first line of a doc block and
use it as the brief description.
I regenerated your documentation with the above change and this is the
result. First your class list: http://api.cakephp.org/annotated.html
now mine: http://dev.ramaboo.com/cakedocs/1.2/html/annotated.html
As you can see with the brief descriptions are now correctly filled in.
You can download my complete Doxyfile at:
http://ramaboo.com/cakedocs/Doxyfile1.2-david
There are a few other changes in it. I was trying to create aliases as
workarounds for some of the other documentation bugs caused by using
phpDocumentor style commands instead of Doxygen style commands. It was
somewhat successfully though in the end I determined it couldn't be done
with just a Doxyfile change (some php files would have to be fixed to make
everything in Doxygen work). The most important change though is the
JAVADOC_AUTOBRIEF = YES which will give you the brief descriptions next to
the class names.
Hope it helps
David
[email protected]
--
Ticket URL: <https://trac.cakephp.org/ticket/5910>
CakePHP : The Rapid Development Framework for PHP <https://trac.cakephp.org/>
Cake is a rapid development framework for PHP which uses commonly known design
patterns like ActiveRecord, Association Data Mapping, Front Controller and MVC.
Our primary goal is to provide a structured framework that enables PHP users at
all levels to rapidly develop robust web applications, without any loss to
flexibility.
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"tickets cakephp" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/tickets-cakephp?hl=en
-~----------~----~----~----~------~----~------~--~---
