[yugecin]

for the 6 people that actually document their code

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 took some time to document the default SA-MP includes using the documentation from SA-MP wiki.
You can find them in the basdon/documented-samp-pawn-api repo.

Note that functions will not show up unless you use them in the script. Callbacks always show up.

Here's a demo report using a simple script that calls all available functions (minus the ones that I forgot). (Requires a browser that supports XSLT, might be heavy to load). This uses my customized pawn doc style.

This might also be useful if the wiki is temporarily down or if your whole country is blocked from sa-mp wiki because of some lesser friendly people that are causing troubles.



Not sure if this is the correct section. I don't think I need to say this but I obviously did not write the actual code, I only appended the documentation comments, which are copied from sa-mp wiki.

[yugecin]

Quote:

Originally Posted by ****** One small change I've always wished the default includes had, but never done as I didn't want to confuse things with mutliple copies, was const-correctness in the default natives.

I was thinking about fixing things like that in the files, but then thought I should just leave it alone.

Quote:

Originally Posted by ****** Your effort adds documentation. Would you be interested in combining efforts to produce a definitive re-issued default library set?

Sure!