Re: PEAR Guide/Docs

On Thu, 27 Mar 2003, Bertrand Mansion wrote: > I've tried for the fourth time to get my hand on Docbook XML and PEARDOC. > Now, I think all this is just a piece of shit. It made me loose many hours > just to write some ugly documentation. Only hard part about peardoc(2) docbook was to install a working build enviroment. Docbook is being used in numerous projects as a standard documentation method. So I wouldn't call it piece of shit. It is just a bit annoying first when you dont't understand how it works. > So my conclusion is that I am not going to write any docs for my packages as > long as there is no proper tool to write it. It already takes enough time to > add code comments PHPdoc style. I might write documentation some day but > certainly not with docbook. I'd suggest you read the "Requirements for contributing code" in pearweb: http://pear.php.net/manual/en/developers.contributing.php "Documentation in an appropriate format (plain text, docbook) Your code has to come with appropriate documentation in one of the following formats: Docbook XML Plain Text" So you just decided you wont write any docs? > > A web frontend or a GTK app would make it for me. I don't want to install > openjade or whatever DTD that will take Mb on my disk just to write a few Harddisk space is virtually free these days. -- Mika Tuupola http://www.appelsiini.net/~tuupola/