1
0
Commit Graph

305 Commits

Author SHA1 Message Date
STRWarrior
c5b89ea0f5 Fixed typo's in the documentation. 2014-01-01 15:02:43 +01:00
STRWarrior
db935c4194 Documented OnPlayerFished and OnPlayerFishing. 2013-12-31 14:50:46 +01:00
madmaxoft
61254d0356 APIDump: Fixed a factual error in OnPluginsLoaded description. 2013-12-29 14:48:58 +01:00
madmaxoft
61af77a5c5 APIDump: Static files overwrite their destination. 2013-12-29 13:24:38 +01:00
madmaxoft
8406a37ac2 APIDump: The PRE html tag has tab width set to 2 spaces. 2013-12-29 13:23:30 +01:00
madmaxoft
b84cd0b3c5 APIDump: Documented OnPluginsLoaded. 2013-12-29 13:15:46 +01:00
madmaxoft
537d1c4e42 APIDump: Added the SettingUpDecoda article.
This implements #383.
2013-12-27 20:56:01 +01:00
madmaxoft
9689896f9c APIDump: Articles eplicitly declare being UTF-8.
This fixes display in firefox.
2013-12-27 20:48:11 +01:00
madmaxoft
e4c6e853ea APIDump: Added quick links to index to each class and hook file.
Third part of #403.
2013-12-27 15:48:01 +01:00
madmaxoft
9a9888a8cc APIDump: Added a quick-nav menu to hook descriptions.
Second part of #403.
2013-12-27 15:36:28 +01:00
madmaxoft
b99255820b APIDump: Added a quick-nav menu to class descriptions.
First part of #403.
2013-12-27 15:26:41 +01:00
madmaxoft
0c071c5937 APIDump: Split the huge DumpAPIHtml function into smaller ones. 2013-12-27 15:08:27 +01:00
madmaxoft
daeb37b27b APIDump: Extra pages renamed to articles and moved to front. 2013-12-27 15:01:49 +01:00
madmaxoft
270d79d47b APIDump: Fixed the WritingPlugin article.
The code is no longer weirdly indented in the browser, and links are relative to the API docs root.
2013-12-27 14:46:07 +01:00
madmaxoft
f0ca18d72a APIDump: Added the WritingPlugin article to the exported pages. 2013-12-27 14:33:15 +01:00
madmaxoft
1a3a291bde APIDump: Fixed bad for-loop.
How did I not see this before?
2013-12-27 14:32:40 +01:00
Tiger Wang
d41f724a40 Writing a plugin APIDump article (#382) 2013-12-26 15:11:48 +00:00
Alexander Harkness
8c6337ff20 Removed documentation for cChatColour:MakeColor() 2013-12-24 13:25:03 +00:00
Alexander Harkness
1f03fc4bf9 Or not. Fixes #384 2013-12-20 17:35:59 +00:00
Alexander Harkness
ba5e42de40 done... finally 2013-12-20 17:12:39 +00:00
Alexander Harkness
d31fd1528b fix the issues xoft pointed out 2013-12-20 16:38:10 +00:00
Alexander Harkness
837bbf0de3 @madmaxoft now? 2013-12-20 16:31:30 +00:00
Alexander Harkness
675c35708b Possibly fixes #384
@madmaxoft, is this the right syntax for lua for loops?
2013-12-20 16:14:49 +00:00
Alexander Harkness
71006f5df5 Create a static folder for adding static files.
.gitignore is basically just an empty file that might serve a purpose someday.
2013-12-20 16:03:26 +00:00
madmaxoft
5d4e1725d4 APIDump: Ignoring the multi-inheritance members.
We may get to documenting them one day, but for now they are unused anyway, so there's no point in documenting them. They are a by-product of multiple inheritance, re-introduced due to #422.
2013-12-16 22:13:46 +01:00
STRWarrior
6e30e54eb0 Documented ForceSetSpeed. 2013-12-15 20:27:19 +01:00
STRWarrior
ae061d717b APIDump: Documented New functions 2013-12-15 15:18:53 +01:00
STRWarrior
a4393dbf6c Documented cTNTEntity. 2013-12-14 16:40:51 +01:00
STRWarrior
e03e8b7b30 Documented OnWorldStarted. 2013-12-11 12:44:13 +01:00
STRWarrior
02301bc987 Documented SpawnFallingBlock() 2013-12-07 14:30:17 +01:00
madmaxoft
a02ed3b92e APIDump: Documented the new cPluginManager:GetCurrentPlugin() function. 2013-12-05 22:06:52 +01:00
madmaxoft
e07c54f7f8 APIDump: Added missing params to OnPlayerRightClick() hook. 2013-12-02 22:36:59 +01:00
madmaxoft
ca79a1a6a6 APIDump: Updated the project file to include all partial docs files. 2013-11-30 13:36:40 +01:00
STRWarrior
686e0c12e2 cWorld::SpawnExperienceOrb() now returns the entity ID of the spawned orb.
Documented etExpOrb.
2013-11-26 15:37:15 +01:00
STRWarrior
a0c6342a29 Documented SpawnExperienceOrb in cWorld 2013-11-25 21:51:52 +01:00
madmaxoft
e683c54b49 APIDump: Moved projectiles' documentation to a separate file. 2013-11-24 10:08:04 +01:00
madmaxoft
51b02854f9 APIDump: Removed needless whitespace output. 2013-11-24 10:03:02 +01:00
madmaxoft
38fe16d8b6 APIDump: Removed unwanted functions. 2013-11-23 21:43:38 +01:00
madmaxoft
3ef7f2008f APIDump: Reformatted the sqlite docs. 2013-11-23 21:32:18 +01:00
madmaxoft
d9dc241e6f APIDump: The descriptions are read from multiple files.
All the files in the Classes subfolder are read for class descriptions, and in the Hooks subfolder for the hook descriptions.
2013-11-23 21:27:02 +01:00
STRWarrior
cc77ffd069 Documented sqlite functions. Used: http://lua.sqlite.org/index.cgi/doc/tip/doc/lsqlite3.wiki#sqlite3_functions 2013-11-23 21:13:55 +01:00
madmaxoft
520088fc7c APIDump: Added more constant groups.
Also fixed the parsing of the Include data in the constant groups, and added linkification to group texts.
2013-11-23 19:40:35 +01:00
madmaxoft
b8aaf13a12 APIDump: Added a few constant groups to the descriptions. 2013-11-22 22:12:46 +01:00
madmaxoft
7a2170f6b3 APIDump: Implemented constant groups.
Fix #289.
2013-11-22 21:46:06 +01:00
madmaxoft
63753c5e84 Added cFile:GetFolderContents().
Fix 162.
2013-11-22 20:11:24 +01:00
madmaxoft
4fbfe59ea0 APIDump: Fixed cRoot's furnace query API. 2013-11-22 16:52:09 +01:00
madmaxoft
7fd3fda5d3 APIDump: Documented new cRoot:GetFurnaceRecipe(). 2013-11-22 12:37:55 +01:00
madmaxoft
98be3ca0e4 APIDump: Documented cPlayer XP-related functions. 2013-11-21 22:12:52 +01:00
madmaxoft
e9a8b96479 APIDump: Documented cWorld:ForEachBlockEntityInChunk() and cWorld:DoWithBlockEntityAt(). 2013-11-20 22:04:16 +01:00
madmaxoft
e2ea6b59f5 APIDump: Slight performance improvement.
Strings don't need concatenation when using write().
2013-11-19 09:56:36 +01:00
madmaxoft
4844422e06 APIDump: Documented Vector3i. 2013-11-19 06:49:21 +01:00
madmaxoft
9bc79722c7 APIDump: Documented Vector3f. 2013-11-17 23:27:07 +01:00
madmaxoft
d96f622437 APIDump: Documented lxp, the XML parser class. 2013-11-15 22:39:27 +01:00
madmaxoft
905cd0e73e APIDump: Functions that are documented are never ignored.
This simplifies exclude-filters for functions such as lxp.new() that need inclusion.
2013-11-15 22:39:02 +01:00
madmaxoft
2ed8e38419 APIDump: Small fixes and additions. 2013-11-15 13:44:07 +01:00
madmaxoft
26d3dd3466 APIDump: Documented cSignEntity. 2013-11-15 13:34:20 +01:00
madmaxoft
7586e832bf APIDump: Documented cNoteEntity. 2013-11-15 13:10:36 +01:00
madmaxoft
194aa1decb APIDump: Documented the cJukeboxEntity. 2013-11-15 12:42:35 +01:00
madmaxoft
4f2645d0e5 APIDump: Documented cChunkDesc:GetBlockEntity(). 2013-11-15 11:34:43 +01:00
madmaxoft
90fc51c4d0 cRoot::SaveAllChunks() doesn't wait for the save (deadlocks).
Rather, it only queues the save task onto each world's tick thread.
2013-11-15 10:13:32 +01:00
madmaxoft
6e5d7b70a1 APIDump: Removed the BlockEntity constructors' docs. 2013-11-15 10:09:54 +01:00
madmaxoft
9287349cc2 APIDump: Documented Vector3d. 2013-11-11 16:02:10 +01:00
madmaxoft
0762893ee1 APIDump: Documented cServer:IsHardCore() 2013-11-09 21:18:03 +01:00
madmaxoft
148f723632 APIDump: Documented TakeDamageInfo. 2013-11-09 19:25:03 +01:00
madmaxoft
d74b0dbd5b APIDump: Documented the relevant tolua functions. 2013-11-09 19:16:44 +01:00
madmaxoft
157bd150fd APIDump: Added logging to see what takes so long. 2013-11-09 18:55:24 +01:00
madmaxoft
13800a0023 APIDump: Documented ItemCategory. 2013-11-05 22:16:42 +01:00
madmaxoft
d1e51886e5 APIDump: Fixed HOOK_LOGIN short desc. 2013-10-31 23:47:46 +01:00
madmaxoft
2bb1dd5015 APIDump: Documented cWindow. 2013-10-28 13:32:10 +01:00
madmaxoft
1a29c19619 APIDump: Documented HTTPFormData and HTTPRequest. 2013-10-28 13:08:14 +01:00
madmaxoft
aca526d158 APIDump: Fixed a failure in documented classes with no functions. 2013-10-28 13:07:30 +01:00
madmaxoft
4f32079692 APIDump: Documented cWorld. 2013-10-27 09:45:02 +01:00
madmaxoft
4871968bc9 APIDump: Documented cRoot. 2013-10-27 09:39:11 +01:00
madmaxoft
5d58457c9e APIDump: Documented cProjectileEntity. 2013-10-27 09:29:02 +01:00
madmaxoft
73e7d21387 APIDump: Documented cPickup. 2013-10-26 19:54:51 +02:00
madmaxoft
e7b3ced70b APIDump: Documented cIniFile. 2013-10-26 10:33:44 +02:00
madmaxoft
c875b88758 APIDump: Documented cMonster. 2013-10-24 17:20:52 +02:00
madmaxoft
7c2ba55442 APIDump: Documented cEnchantments.
The constants are self-documenting, no need to describe them further.
2013-10-24 16:32:51 +02:00
madmaxoft
785301c9a0 APIDump: Documented cPickup. 2013-10-24 16:27:48 +02:00
madmaxoft
6cad07c429 APIDump: Documented cItemGrid and cPlayer. 2013-10-24 12:24:40 +02:00
madmaxoft
2cf196a892 APIDump: Added cChatColor constants.
They don't really need much documentation, so just ignoring them in the Undocumented output.
2013-10-23 13:34:44 +02:00
madmaxoft
60abe99d5e APIDump: Documented the cHopperEntity class. 2013-10-23 12:19:43 +02:00
madmaxoft
a91b422594 APIDump: Linkified cEntity returns. 2013-10-23 12:09:34 +02:00
madmaxoft
34de5210d6 APIDump: member variables without a setter are considered constants.
This fixes cChatColor constants being reported erroneously as member variables.
2013-10-22 22:07:39 +02:00
madmaxoft
ec94104a3c APIDump: Inheritance is tested properly.
This fixes #195 's second iteration.
2013-10-22 21:53:35 +02:00
madmaxoft
b571294b6e APIDump: Added link from cItem to the global ItemToString() et al. 2013-10-20 23:43:09 +02:00
madmaxoft
83d2d375c9 APIDump: Fixed link in cPawn's desc. 2013-10-20 23:36:00 +02:00
madmaxoft
70a734d4f9 APIDump: Various small fixes and additions. 2013-10-20 15:32:33 +02:00
madmaxoft
16afec96de APIDump: Fixed a few broken links. 2013-10-20 15:08:30 +02:00
madmaxoft
0230936f61 APIDump: Statistics have a graphical meter; added hooks. 2013-10-20 14:56:09 +02:00
madmaxoft
07a117b096 APIDump: Added basic statistics about the docs. 2013-10-20 11:12:33 +02:00
madmaxoft
4f40eb7f55 APIDump: Fixed listing undocumented objects.
Classes with undefined "Functions" section would not list their functions as undocumented; similar for "Constants" and "Variables".
2013-10-20 10:33:40 +02:00
madmaxoft
0258213d24 Merge branch 'htmlescape'. 2013-10-20 09:14:30 +02:00
madmaxoft
769c98403b APIDump: Undocumented member variables are listed. 2013-10-19 22:44:28 +02:00
madmaxoft
bbcb0ead73 APIDump: Extra pages use the local prettify and CSS. 2013-10-19 22:28:58 +02:00
madmaxoft
3f2813d6ff APIDump: Added member-variable filtering. 2013-10-19 22:21:38 +02:00
Alexander Harkness
d1ddd2492b Added a APIDump description for GetHTMLEscapedString. 2013-10-19 21:18:27 +01:00
madmaxoft
9f8df5f702 APIDump: Member variables are read from the API. 2013-10-19 22:07:06 +02:00
madmaxoft
b59329bf3a APIDump: Better header text for classes. 2013-10-19 21:47:59 +02:00
madmaxoft
be996c1662 APIDump: Added cIniFile additional info. 2013-10-18 23:22:26 +02:00