yugecin/pawndocimproved

COMPATIBILITY NOTICE

XSLT is being removed from the web platform (https://github.com/whatwg/html/issues/11523), so soon this will not work in Chrome/Firefox anymore :( I have no recommendations for alternatives at this moment.

---

The 'improvements' are some fixes, some style changes, and adding SA-MP specific links and appendices.

You might also be interested in documented-samp-pawn-api, which are the default SA-MP include files but with documentation added.

pawndocimproved

base xsl taken from the PAWN repo

Changes (doesn't include all; see commits for everything):

• more uniform style, larger fontsize
• member types each have a different color
• fixed titles showing for empty properties in firefox and chromium
• fixed document not scrolling to anchor on initial page load with url fragment
• add generated index table at the top
• element names are now links that link to their own anchor
• add link to 'top' at the end of every member section
• link to sa-mp wiki mirror (sampwiki.blast.hk) for every member, this is only really useful for members of the SA-MP PAWN API as everything else will 404
• fix invalid html nesting (most text was inside p tags, but that doesn't allow <ul> <ol> <pre> as children)
• support for <b> <strong> <a> table/thead/tbody/tr/th/td <br> <sup> tags in documentation
• ignore __file __date __time members
• added some SA-MP specific appendices (table of keys, damage status info, ...)
• allow freeform text in <seealso> docs, as the PAWN language guide mentions it can be used like that

demo

• sample script with original style
• sample script with improved style
• docs of complete SA-MP PAWN API in improved style

howto

See the PAWN language guide page 52: A tutorial introduction - Documentation comments for the PAWN documentation syntax.

Use the -rfilename PAWN compiler option to generate a report of your code in XML format.

The XML report generates with an absolute link to the pawndoc.xsl stylesheet (href attribute of xml-stylesheet tag) located in the pawno xml directory. Either replace that file with the version of this repository, or change the href value in the generated XML report file after it is generated. You could also replace the href with https://raw.githubusercontent.com/yugecin/pawndocimproved/master/pawndoc.xsl, but this only works in IE and Firefox, chromium does not allow cross domain resources.