Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add documentation #10

Merged
merged 4 commits into from
Jun 19, 2018
Merged

add documentation #10

merged 4 commits into from
Jun 19, 2018

Conversation

yugecin
Copy link
Contributor

@yugecin yugecin commented Jun 17, 2018 •
edited
Loading

Adds pawndoc to the functions, coming from sa-mp wiki (see basdon/documented-samp-pawn-api).

Notes:

  • some doc missing, 0.3.7-DL or NPC functions/callbacks (GetPlayerCustomSkin AddCharModel AddSimpleModel AddSimpleModelTimed FindModelFileNameFromCRC FindTextureFileNameFromCRC RedirectDownload OnPlayerRequestDownload NPC:GetPlayerArmedWeapon NPC:GetPlayerHealth NPC:GetPlayerArmour)
  • GetPlayerIP: parameter name renamed to ip (reverted)
  • the documentation also uses <b> and <a> tags, which will not work with the default XSLT file that comes with pawn. I've left them in there because they are useful if customized XSLT files are used (see yugecin/pawndocimproved), and it will not cause troubles if the default is used.

@yugecin
Copy link
Contributor Author

yugecin commented Jun 17, 2018

linking #4

@Southclaws Southclaws merged commit 034d052 into pawn-lang:master Jun 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@yugecin @Y-Less @Southclaws