ElkArte Community

Project Support => General ElkArte discussions => Topic started by: Joshua Dickerson on February 21, 2014, 12:51:49 pm

Title: Documentation
Post by: Joshua Dickerson on February 21, 2014, 12:51:49 pm
@Spuds and I were just talking about documentation.

phpDoc or apigen?

I think the biggest thing is that it needs to have a way of searching. I think the best way to handle searching is using javascript to inject a search form which would go to Google's insite search. That way nobody had to handle any scripts.
Title: Re: Documentation
Post by: Spuds on February 21, 2014, 04:40:42 pm
And as an example of the auto generated docs http://elkarte.github.io/Docs/  is the output of phpdoc

Of course the output is only as good as the input, we still have work to do on that, but that's an ongoing, never ending, update,/fix/etc as you want task

ETA: Trying apigen docs now
Title: Re: Documentation
Post by: Joshua Dickerson on February 23, 2014, 10:34:28 pm
I get a 404
Title: Re: Documentation
Post by: Spuds on February 24, 2014, 10:52:08 am
Opps  :-*

I was thrashing that github repo, jumping between swapping apigen for phpdoc and different templates and it just seemed to lock up at one point so I deleted the old one and recreated it, but called it Doc and not Docs :P

New link:  http://elkarte.github.io/Doc/   <- those are apigen docs and I used @pacakage tags in a couple of areas to show how the grouping can work.
Title: Re: Documentation
Post by: TE on February 28, 2014, 12:14:30 pm
That new online documentation is soooo wonderful, well done @Spuds
Title: Re: Documentation
Post by: Spuds on February 28, 2014, 05:44:46 pm
Thanks  :)  ... I've settled on apigen and will do some additional grouping using @package and some other formatting things going forward.  Just need one of those rainy weekends.
Title: Re: Documentation
Post by: Spuds on September 15, 2014, 10:23:28 am
Just a bump that I updated the generated code docs to the 1.0 release  ... http://elkarte.github.io/Doc/