[Tool/Web/Other] Improved pawn doc style - Printable Version

+- SA-MP Forums Archive (https://sampforum.blast.hk)
+-- Forum: SA-MP Scripting and Plugins (https://sampforum.blast.hk/forumdisplay.php?fid=8)
+--- Forum: Filterscripts (https://sampforum.blast.hk/forumdisplay.php?fid=17)
+---- Forum: Tools and Files (https://sampforum.blast.hk/forumdisplay.php?fid=82)
+---- Thread: [Tool/Web/Other] Improved pawn doc style (/showthread.php?tid=649043)

---

Improved pawn doc style - yugecin - 01.02.2018

improved is subjective

About

Some of you may know you can write documentation in your PAWN code and the compiler can generate a report for you. See [Tutorial] Pawn Documentation Comments/Tags or just read the PAWN language guide (around page 52).

I found some things were annoying, so I changed the style a little bit.
Here are the most notable changes:

• more uniform style
• member types each have a different color
• fixed showing empty properties in firefox and chromium
• generated index table
• larger fontsize
• auto link to sa-mp wiki for every member
• support for <b> <strong> <a> tags
• ignore __file __date __time members

Examples/Demo

If you want to compare, check out the demo reports with the normal style and with my modified style. (Requires a browser that can do XSLT. Demo code partly copied from the PAWN language guide.)

Download/Usage

pawndoc.xsl
After the report has been generated, change the xml-stylesheet href in the generated xml file (should be on the 2nd line) to pawndoc.xsl and put the xsl file in the same folder. Then open the xml file with your favorite browser (that supports XSLT).

https://github.com/yugecin/pawndocimproved

---

Re: Improved pawn doc style - Freaksken - 02.02.2018

Didn't even know :O. This is how I did it before seeing this:

---