Documentation 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.
Re: Documentation Reply #1 – 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 taskETA: Trying apigen docs now
Re: Documentation Reply #3 – 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 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.
Re: Documentation Reply #4 – February 28, 2014, 12:14:30 pm That new online documentation is soooo wonderful, well done @Spuds
Re: Documentation Reply #5 – 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.
Re: Documentation Reply #6 – 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/