Re: Suggestion for a new documentation format

Hi, This is something I put together sometime ago (couldn't look into this further). Doc https://docs.google.com/document/d/1imcgU7F1Sf3g19DpTO7vVxOaP0b6VzoMUq6DBNTLEDU/edit On Mon, Aug 10, 2015 at 7:03 AM, Sherif Ramadan <theanomaly.is@gmail.com> wrote: > Hi, > > I'm not sure I agree specifically with using markdown for the > documentation. There are many different flavors of markdown and a wide > array of nuances that would come with parsing our documentation from a > markdown. > > I do think that providing better and more accessible tools that parse the > existing XML into more domain specific serializations for a particular > application's consumption is a good idea. Though moving to a markdown > certainly isn't going to make that an improvement to the status quo. > > For example, I've had to write scripts in the past that take our XML > documentation and parse function names and prototypes into JSON format for > application specific auto-complete integration. This really isn't hard to > do, but it's also not the simplest thing in the world if you're not at all > familiar with our docs. > > I'd be happy to put together a simple PHP script that can do such things > and put it up on Github if you think it will help with 3rd party > integration. > > On Sun, Aug 9, 2015 at 6:28 PM, Pedro Heliodoro <jarodium@gmail.com> > wrote: > >> Hello all >> >> I would like to suggest that PHP functions should be documented in MD ( >> Markdown ) files, so that documentation should be easily read by IDE >> editors universally and help people around the world integrate the docs in >> their tools. >> >> >> Regards >> > > -- *Pasindu De Silva**ppasindud@gmail.com <ppasindud@gmail.com>*