The Joomla! Forum ™

Download

Demo


Board index » Joomla! Development Forums » Joomla! Development » Joomla! 1.5 Coding

Forum rules


Please use the mailing list here: http://groups.google.com/group/joomla-dev-general rather than this forum.



Post new topic Reply to topic  Page 1 of 1
  [ 5 posts ] 
  Print view Previous topic | Next topic 
Author Message
dchapiesky
PostPosted: Wed Aug 29, 2007 8:36 am 
User avatar
Joomla! Enthusiast
Joomla! Enthusiast

Joined: Wed Aug 29, 2007 8:00 am
Posts: 104
Location: Charlotte, NC
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

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


Last edited by pe7er on Wed Aug 29, 2007 10:26 am, edited 1 time in total.

Top
 Profile  
 
dchapiesky
PostPosted: Wed Aug 29, 2007 8:40 am 
User avatar
Joomla! Enthusiast
Joomla! Enthusiast

Joined: Wed Aug 29, 2007 8:00 am
Posts: 104
Location: Charlotte, NC
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.
Top
 Profile  
 
pe7er
PostPosted: Wed Aug 29, 2007 10:30 am 
User avatar
Joomla! Master
Joomla! Master

Joined: Thu Aug 18, 2005 8:55 pm
Posts: 18092
Location: Nijmegen, The Netherlands
[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 - Community Leadership Team
http://www.db8.nl - Joomla specialist, Nijmegen, Nederland
Joomla 2.5 multilanguage in 10 steps: http://www.db8.nl/multilanguage-in-10-steps
Top
 Profile  
 
StarShaper
PostPosted: Wed Aug 29, 2007 5:43 pm 
Joomla! Explorer
Joomla! Explorer

Joined: Wed Sep 27, 2006 11:55 pm
Posts: 347
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.

Top
 Profile  
 
dchapiesky
PostPosted: Fri Aug 31, 2007 1:34 am 
User avatar
Joomla! Enthusiast
Joomla! Enthusiast

Joined: Wed Aug 29, 2007 8:00 am
Posts: 104
Location: Charlotte, NC
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.
Top
 Profile  
 
Display posts from previous:  Sort by  
Post new topic Reply to topic  Page 1 of 1
  [ 5 posts ] 


Board index » Joomla! Development Forums » Joomla! Development » Joomla! 1.5 Coding

Who is online

Users browsing this forum: No registered users and 4 guests

You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Jump to:  
Powered by phpBB® Forum Software © phpBB Group