Doxygen: Tool for documenting source code Joomla 1.5?

For Joomla! 1.5 Coding related discussions, please use: http://groups.google.com/group/joomla-dev-general
Locked
User avatar
dchapiesky
Joomla! Enthusiast
Joomla! Enthusiast
Posts: 104
Joined: Wed Aug 29, 2007 8:00 am
Location: Charlotte, NC
Contact:

Doxygen: Tool for documenting source code Joomla 1.5?

Post by dchapiesky » Wed Aug 29, 2007 8:36 am

Hello...

Just throwing in my two cents... Has the development team and documentation team considered embedding some documentation as part of the source code - i.e. using a tool such as Doxygen to build up to the minute documentation from actual source code comments.

I have used the tool on large mixed source projects (C++, PHP, SQL) and it works remarkably well. 

The main reason I suggest it is that you can specify categories which group together in the final documentation: DIFFFROM1 or ONLY15 would allow changes which differ from Joomla 1.0 or are unique to 1.5 to be grouped and documented together easily - as the code changes day to day.

I know source documenters such as Doxygen are like religions - everyone is a zealot - I think it would interesting to explore this as an option though.

Daniel
Last edited by pe7er on Wed Aug 29, 2007 10:26 am, edited 1 time in total.
Ya' gotta get over this sometime... How about now... - L. W.

 
User avatar
dchapiesky
Joomla! Enthusiast
Joomla! Enthusiast
Posts: 104
Joined: Wed Aug 29, 2007 8:00 am
Location: Charlotte, NC
Contact:

Re: v 1.5 Interface Changes

Post by dchapiesky » Wed Aug 29, 2007 8:40 am

Oh,

one other thing... this would obviously be supplemental to the already substantial contribution of the documentation team.  If anything, it would allow developers to develop and make notes which the documentation team can then compile and turn in to human readable form  :laugh:
Ya' gotta get over this sometime... How about now... - L. W.

User avatar
pe7er
Joomla! Master
Joomla! Master
Posts: 22420
Joined: Thu Aug 18, 2005 8:55 pm
Location: Nijmegen, Netherlands
Contact:

Re: Doxygen: Tool for documenting source code Joomla 1.5?

Post by pe7er » Wed Aug 29, 2007 10:30 am

[MOD note: Topic split from http://forum.joomla.org/index.php/topic,175613.0.html & topic renamed]

Thanks for the interesting suggestion!
Doxygen is an open source documentation tool and available at http://www.doxygen.org
Kind Regards,
Peter Martin, Global Moderator
https://db8.nl - Joomla specialist, Nijmegen, Nederland
Co-developer of d2 Content https://data2site.com/joomla-extensions/d2-content

StarShaper
Joomla! Explorer
Joomla! Explorer
Posts: 347
Joined: Wed Sep 27, 2006 11:55 pm

Re: Doxygen: Tool for documenting source code Joomla 1.5?

Post by StarShaper » Wed Aug 29, 2007 5:43 pm

Joomla is using phpDocumentator (http://www.phpdoc.org/) for source documentation. Doxygen is pretty good for C++ projects, but phpDocumentator is better suited for PHP Projects.
Last edited by StarShaper on Wed Aug 29, 2007 5:45 pm, edited 1 time in total.

User avatar
dchapiesky
Joomla! Enthusiast
Joomla! Enthusiast
Posts: 104
Joined: Wed Aug 29, 2007 8:00 am
Location: Charlotte, NC
Contact:

Re: Doxygen: Tool for documenting source code Joomla 1.5?

Post by dchapiesky » Fri Aug 31, 2007 1:34 am

In terms of phpDocumenter (I'm not familiar with it...  ???) Does it have the ability to specify the subgroups of which I spoke of above? In this thread - for documenting differences between 1.0 and 1.5 - that would give the documentation team a heads up on what to pay attention to when writing the upgrade literature.

Anyhoo.. Doxygen supports php also..

Q: is there a formal doc on coding standards and doc standards using phpDocumenter in the Joomla project. I looked but haven't found one yet.

Daniel
Ya' gotta get over this sometime... How about now... - L. W.

 

Locked

Return to “Joomla! 1.5 Coding”