How can I extract the doc comments in the XML file ?

pawn-lang / YSI-Includes

Just the YSI include files, none of the extra stuff.

211 stars 107 forks source link

How can I extract the doc comments in the XML file ? #61

Open C-far opened 8 years ago

C-far commented 8 years ago

Hi, I've seen the docs in the files before each function and I've seen it is possible to get a XML file. When we open this XML file, we see by example this : http://i.imgur.com/8svrBPb.png (Guide Pawn pdf)

So, how can I do this ? Regards.

Crayder commented 8 years ago

They are in XML format already... And they are all in 'documentation' comments (they are wrapped in comments that use two asterisks instead of just one). Parse and extract those comments.

(I think the pawn toolkit has a parser that does this for you, if I remember correctly)

EDIT: Scratch that, I want this too... XD

Crayder commented 8 years ago

Figured it out.

First download the pawn toolkit and put the xml folder with your compiler. Add the '-r' option to the compiler and it'll output an xml. Open that xml and you have it.

Ahmad45123 commented 8 years ago

I and @Crayder are working on extracting all the docs to the wiki by the way. In case that's what you want.

Crayder commented 8 years ago

Well that's not directly related, since I actually planned on doing that before (I have proof, just read the current wiki home page XD).

C-far commented 8 years ago

It's weird, 'cause I managed to have the rendering of the XML file, but only by :

placing the XML file in the folder pawno\xml.
editing the XML file and the XLS fle at the lines "<?xml-stylesheet ?>" (for XML) and " (for XLS).

Crayder commented 8 years ago

Yeah I had to edit the xsl path inside my xml, but after that it worked perfectly fine.