Ack -- my [1] reference was supposed to be https://www.ohloh.net/ but
thinking about it; we want documentation search not code search and ideally
it would be opensource... but my point remains! We need a cross
language/documentation search system.

~Matt Walker
Wikimedia Foundation
Fundraising Technology Team


On Fri, Jul 5, 2013 at 6:06 PM, Matthew Walker <[email protected]>wrote:

> Could we maybe get use PHPDoc to generate MediaWiki docs, so that we can
>> compare them side-by-side.
>
>
> This is an important request because (to play devil's advocate here a
> little bit)...
>
> > 1. Not be tortoise slow
> Pretty sure this only matters because we do continuous integration -- we
> probably don't need to do this for every commit...? Maybe once a day?
>
> In any case -- who says PHPDoc is any faster.
>
> > 2. Have usable search
> The demo at least doesn't even offer search functionality...
>
> But does this even matter? I would argue in favour of a independent search
> solution along the lines of Ohloh [1] so that we can integrate our JSDuck
> documentation.
>
> > 3. Prettier interface
> Prettier does not mean more usable. Imho after playing with their online
> demo for 5 minutes it was *less* usable than doxygen. Additionally, if
> you think doxygen is ugly, we can reskin it!
>
> ~Matt Walker
> Wikimedia Foundation
> Fundraising Technology Team
>
>
> On Fri, Jul 5, 2013 at 5:39 PM, Tyler Romeo <[email protected]> wrote:
>
>> Could we maybe get use PHPDoc to generate MediaWiki docs, so that we can
>> compare them side-by-side.
>>
>> *-- *
>> *Tyler Romeo*
>> Stevens Institute of Technology, Class of 2016
>> Major in Computer Science
>> www.whizkidztech.com | [email protected]
>>
>>
>> On Fri, Jul 5, 2013 at 8:36 PM, Yuvi Panda <[email protected]> wrote:
>>
>> > Hello! Our current generated documentation[1] uses doxygen, and
>> > leaves... a number of things to be desired - such as:
>> >
>> > 1. Not be tortoise slow
>> > 2. Have usable search
>> > 3. Prettier interface
>> >
>> > I was looking around for alternatives, and ran into phpdocumentor2[2].
>> > The project still seems active (latest commit was 3 days ago, and for
>> > vagrant support!), and the demo was quite pretty:
>> >
>> > http://demo.phpdoc.org/Responsive/namespaces/phpDocumentor.html
>> >
>> > Is there any particular reason we are still sticking with doxygen? Or
>> > is it just 'someone needs to find the time to move things over to the
>> > new system'?
>> >
>> > [1]: https://doc.wikimedia.org/mediawiki-core/master/php/html/
>> > [2]: http://www.phpdoc.org/
>> >
>> > --
>> > Yuvi Panda T
>> > http://yuvi.in/blog
>> >
>> > _______________________________________________
>> > Wikitech-l mailing list
>> > [email protected]
>> > https://lists.wikimedia.org/mailman/listinfo/wikitech-l
>> _______________________________________________
>> Wikitech-l mailing list
>> [email protected]
>> https://lists.wikimedia.org/mailman/listinfo/wikitech-l
>>
>
>
_______________________________________________
Wikitech-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikitech-l

Reply via email to