Re: cvs: phpdoc / manual.xml.in /en/chapters streams.common.xml streams.constants.xml streams.dir.xml streams.file.xml streams.socket.xml
streams.structs.xml streams.xml

> Could you prepare the structure for this? > I'm still a "phpdoc newbie", and somewhat pressed for time, so if > you could create the new directories and touch empty files with the > appropriate name (or even create skeleton files that will "build" > correctly), and add the relevant magic to manual.xml.in, I will add the > updated docs in the correct place. This just needs to be delayed, until we decide what's the right method. I would not like to hurry and make mistakes as this was done several times before... > One thing I have noticed while writing these docs is that the > <function> element does not automatically link to the <refentry> > element (as it does for PHP functions). I presume that this is > to do with the names I have chosen for their id attributes? Yes, it works with IDs... > Since these functions are C functions, rather than PHP functions, > I wanted to be sure that I didn't collide with the PHP function > namespace. Should I not worry about that and adopt the function.xxx > naming for my refentry IDs? I don't think so that this is a good idea. I am for a manual split... > Also, I need to document C structures; do you have some guidelines > for this? I discovered <structname> and <structfield> elements, > but I don't have any real documentation on how they are used, > and there doesn't seem to be a way to describe array members > correctly. Should I just stick to using a <programlisting role="c"> > element to contain the relevant structures from the C headers? Maybe this would work sufficiently for the first time. I never documented C code using docbook, so I don't know what are the appropriate tags for structure documentation. <structname> and <structfield> are obviously not the right tags for this, as their documentation shows... Goba