1
0
Commit Graph

379 Commits

Author SHA1 Message Date
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
madmaxoft
1b7a84d494 APIDump: Offline prettify is working. 2013-10-18 22:02:06 +02:00
madmaxoft
1e67ff3499 APIDump: Added example code to cItem. 2013-10-18 21:49:07 +02:00
madmaxoft
373900964c APIDump: Documented cItem's variables. 2013-10-18 21:38:44 +02:00
madmaxoft
07ba48840d APIDump: Added support for member variables. 2013-10-18 21:29:38 +02:00
madmaxoft
314c7d98fb APIDump: Added prettify's license. 2013-10-18 21:27:35 +02:00
madmaxoft
db2d4aa4e3 APIDump: Fixed offline JS.
This time it's really offline :)
2013-10-18 21:02:43 +02:00
madmaxoft
77af5c6fe7 APIDump: Do not list empty Constants or Functions sections.
Also implemented writing inherited constants.
2013-10-18 20:49:30 +02:00
madmaxoft
778d786349 APIDump: Split long code into functions. 2013-10-18 20:32:36 +02:00
madmaxoft
41270dc02e APIDump: Ignore internal APIDump stuff. 2013-10-18 20:22:24 +02:00
madmaxoft
201c84afb3 APIDump: using local JS files instead of networked.
This allows offline API browsing.
2013-10-18 20:21:26 +02:00
madmaxoft
1c0ab57d12 APIDump: Renamed output for helper stuff.
Undocumented objects are output to _undocumented.lua
Overdocumented objects are output to _unexported-documented.txt
Missing pages are output to _missingPages.txt
2013-10-18 12:33:46 +02:00
madmaxoft
22102b4a64 APIDump: Makes a list of bad links.
This fixes #219.
2013-10-18 12:30:06 +02:00
madmaxoft
5992c41501 APIDump: Improved page titles. 2013-10-18 11:56:58 +02:00
madmaxoft
9776b89fb7 APIDump: Documented HOOK_PLAYER_RIGHT_CLICKING_ENTITY. 2013-10-18 10:04:44 +02:00
madmaxoft
5a31d191eb APIDump: Documented HOOK_PLAYER_SHOOTING. 2013-10-18 09:57:35 +02:00
madmaxoft
8020cbd3d7 APIDump: Documented HOOK_PLAYER_SPAWNED. 2013-10-18 09:47:21 +02:00
madmaxoft
1f6498de22 APIDump: Documented HOOK_PLAYER_TOSSING_ITEM. 2013-10-18 09:40:18 +02:00
madmaxoft
fd7c1754d0 APIDump: Documented HOOK_PLAYER_USED_BLOCK. 2013-10-17 17:14:57 +02:00
madmaxoft
dfd4c78c87 APIDump: Documented HOOK_PLAYER_USED_ITEM. 2013-10-17 17:10:46 +02:00
madmaxoft
91f7662a51 APIDump: Documented HOOK_PLAYER_USING_BLOCK. 2013-10-17 16:38:46 +02:00
madmaxoft
96072c9e0c APIDump: Documented HOOK_PLAYER_USING_ITEM. 2013-10-17 16:31:35 +02:00
madmaxoft
ed935d82bb APIDump: Documented HOOK_UPDATED_SIGN. 2013-10-17 16:18:16 +02:00
madmaxoft
d3f5a979b4 APIDump: Documented HOOK_TICK. 2013-10-17 16:07:18 +02:00
madmaxoft
36f6ffaadf APIDump: Documented HOOK_TAKE_DAMAGE. 2013-10-17 15:20:44 +02:00
madmaxoft
424807e331 APIDump: Documented HOOK_UPDATING_SIGN. 2013-10-17 13:54:53 +02:00
madmaxoft
1ef2e0e6a6 APIDump: More robust against missing APIDesc items. 2013-10-17 13:54:41 +02:00
madmaxoft
d688ac8e50 APIDump: Documented HOOK_WEATHER_CHANGED. 2013-10-16 15:47:27 +02:00
madmaxoft
0aa20762bc APIDump: Documented HOOK_WEATHER_CHANGING. 2013-10-16 15:44:04 +02:00
madmaxoft
f8e3cbe44f APIDump: Documented HOOK_WORLD_TICK. 2013-10-16 15:33:56 +02:00
madmaxoft
dbd925a7a4 APIDump: Nicer HTML visage.
* Fixed whacky HTML indentation
+ Added fancy CSS!
+ Now HTML5 compatible!
2013-10-16 08:04:06 +02:00
Alexander Harkness
17aff20666 Added HOOK_PLAYER_RIGHT_CLICK 2013-10-15 19:57:00 +01:00
madmaxoft
c9a9a30fa5 APIDump: Linkification supports #anchors.
This implements #198.
2013-10-15 18:44:13 +02:00
madmaxoft
9c7ca813d2 APIDump: Documented HOOK_SPAWNING_MONSTER. 2013-10-15 18:12:37 +02:00
madmaxoft
ba6c2b9ef4 APIDump: Documented HOOK_SPAWNING_ENTITY. 2013-10-15 18:06:06 +02:00
madmaxoft
44ec010e15 APIDump: Documented HOOK_SPAWNED_MONSTER. 2013-10-15 17:58:39 +02:00
madmaxoft
167d8d346e APIDump: Documented HOOK_SPAWNED_ENTITY. 2013-10-15 17:55:01 +02:00
madmaxoft
edd1a670ed APIDump: Documented HOOK_PRE_CRAFTING. 2013-10-15 17:43:41 +02:00
madmaxoft
b079676290 APIDump: Documented HOOK_POST_CRAFTING. 2013-10-15 17:35:34 +02:00
madmaxoft
9be35e1222 APIDump: Documented HOOK_PLAYER_PLACING_BLOCK. 2013-10-15 14:58:33 +02:00
madmaxoft
deb2d89506 APIDump: Documented HOOK_PLAYER_MOVING and HOOK_PLAYER_PLACED_BLOCK. 2013-10-15 14:48:29 +02:00
madmaxoft
19e176be20 APIDump: Documented HOOK_PLAYER_LEFT_CLICK. 2013-10-15 11:30:48 +02:00
madmaxoft
90dc2c55d8 APIDump: Documented HOOK_PLAYER_JOINED. 2013-10-15 08:24:44 +02:00
madmaxoft
b902c0b29e APIDump: Documented HOOK_PLAYER_EATING. 2013-10-15 08:18:08 +02:00
madmaxoft
eb466334ad APIDump: Documented HOOK_PLAYER_BROKEN_BLOCK. 2013-10-15 08:11:01 +02:00
madmaxoft
5e71b30116 APIDump: Documented HOOK_PLAYER_BREAKING_BLOCK. 2013-10-15 08:03:46 +02:00
madmaxoft
d34fa4970a APIDump: Documented HOOK_PLAYER_ANIMATION. 2013-10-14 22:01:10 +02:00
madmaxoft
e4bb796c6b APIDump: Removed HOOK_MAX and HOOK_NUM_HOOKS from documentation.
They're not really hooks, just constants for the maximum.
2013-10-14 21:57:23 +02:00
madmaxoft
862397856d APIDump: Documented HOOK_LOGIN. 2013-10-14 21:46:25 +02:00
madmaxoft
a632f1d579 APIDump: Documented HOOK_KILLING. 2013-10-14 21:45:47 +02:00
madmaxoft
315af4450d APIDump: Documented HOOK_HOPPER_PUSHING_ITEM. 2013-10-14 21:45:08 +02:00
madmaxoft
9969c19060 APIDump: Documented HOOK_HOPPER_PULLING_ITEM. 2013-10-14 21:16:28 +02:00
madmaxoft
5c24d5acd7 APIDump: Documented HOOK_HANDSHAKE. 2013-10-14 16:59:45 +02:00
madmaxoft
c360849fa0 APIDump: Documented HOOK_EXPLODING. 2013-10-14 16:53:13 +02:00
madmaxoft
211b03a870 APIDump: Documented HOOK_EXPLODED. 2013-10-14 16:43:39 +02:00
madmaxoft
112e96ae9b APIDump: Documented HOOK_EXECUTE_COMMAND. 2013-10-14 16:20:32 +02:00
madmaxoft
66d8c1b306 APIDump: Updated the template for undocumented hooks. 2013-10-14 16:13:39 +02:00
madmaxoft
56bc94139d APIDump: Documented HOOK_DISCONNECT. 2013-10-14 16:12:32 +02:00
madmaxoft
ca285563d9 APIDump: Fixed info missing from cCraftingRecipe. 2013-10-14 16:04:43 +02:00
madmaxoft
f546a0e180 APIDump: Documented HOOK_CRAFTING_NO_RECIPE. 2013-10-14 16:02:32 +02:00
madmaxoft
c8702e15bb APIDump: Documented HOOK_COLLECTING_PICKUP. 2013-10-14 15:53:41 +02:00
madmaxoft
0b71b3bd14 APIDump: Documented HOOK_CHUNK_UNLOADING. 2013-10-14 15:50:11 +02:00
madmaxoft
37ea7ec0c1 APIDump: Documented HOOK_CHUNK_UNLOADED. 2013-10-14 15:46:01 +02:00
madmaxoft
fb209757f0 APIDump: Documented HOOK_CHUNK_GENERATING. 2013-10-14 09:41:06 +02:00
madmaxoft
42b65c164d APIDump: Fixed undocumented hook param generator. 2013-10-14 09:32:55 +02:00
madmaxoft
8f5ed6511a APIDump: Added example to HOOK_CHUNK_GENERATED. 2013-10-14 09:30:13 +02:00
madmaxoft
23b4aa4820 APIDump: Documented HOOK_CHUNK_GENERATED. 2013-10-14 09:10:33 +02:00
madmaxoft
26fbefdcbf APIDump: The undocumented hooks template now has 8 params.
This allows for easier copypasting, hooks with less than 9 params don't need an extra copy-paste for a new param entry.
2013-10-14 09:03:54 +02:00
madmaxoft
9d7e638aa2 APIDump: Documented HOOK_CHUNK_AVAILABLE. 2013-10-14 09:00:28 +02:00
madmaxoft
058faa74d2 APIDump: Documented the webserver vs world threads.
This fixes #12.
2013-10-12 23:13:26 +02:00
madmaxoft
82834ee1ed APIDump: Added pretty-printing to code examples. 2013-10-12 18:31:55 +02:00
madmaxoft
9b13a401f6 APIDump: Added an OnBlockToPickups() code example. 2013-10-12 18:29:06 +02:00
madmaxoft
dff343b792 APIDump: Added the possibility of extra code examples for hooks. 2013-10-12 18:11:14 +02:00
madmaxoft
50e5afd67d APIDump: Documented OnBlockToPickups. 2013-10-12 11:46:00 +02:00
madmaxoft
990fa9dfe1 APIDump: Hook notes are linkified. 2013-10-12 11:44:59 +02:00
madmaxoft
9deb9cfa0e APIDump: Fixed extra pages copying. 2013-10-09 15:56:24 +02:00
madmaxoft
9dafba5015 APIDump: Implemented basic hook documentation. 2013-10-09 15:10:25 +02:00
madmaxoft
9fc35514e6 APIDump: Documented the new cFile API functions. 2013-10-09 11:31:38 +02:00
madmaxoft
27ce6dd97e APIDump: Added support for extra pages.
Referenced by file links and titles and copied directly from the plugin folder to the dest folder.
2013-10-09 10:24:24 +02:00
madmaxoft
c03e440311 APIDump: Taking advantage of the new cFile API. 2013-10-09 10:02:07 +02:00
madmaxoft
d41f3a1b0c APIDump: Brought cItem docs up-to-date. 2013-10-05 12:01:51 +02:00
madmaxoft
a7401fa832 APIDump: Added cLineBlockTracer documentation. 2013-10-04 21:53:14 +02:00
STRWarrior
fdc67142fd APIDump: Documented cPlugin 2013-10-04 20:58:25 +02:00
madmaxoft
a1898521b0 APIDump: Added the cWorld:IsWeatherXXX() functions. 2013-10-04 08:49:55 +02:00
madmaxoft
5ab6003e0f APIDump: Removed ignored classes logging. 2013-10-02 08:50:43 +02:00
madmaxoft
02c41b6f1d APIDump: Fixed operator == rename having bad DocID. 2013-10-02 08:49:15 +02:00
madmaxoft
4cbe24d2e8 APIDump: Added equality operator renaming. 2013-09-30 20:45:13 +02:00
madmaxoft
9e19d598d0 APIDump: Fixed overloaded functions' docs. 2013-09-29 09:09:13 +02:00
madmaxoft
425073c4aa APIDump: Added more inheritance and linkification. 2013-09-29 08:59:46 +02:00
madmaxoft
6fa0361a64 APIDump: Linkified cDropSpenser constants. 2013-09-29 08:55:31 +02:00
madmaxoft
1f9397302c APIDump: Added the possibility to ignore classes. Ignoring Lua builtins. 2013-09-29 00:10:42 +02:00
madmaxoft
5e7e4b3a28 APIDump: Updated cEntity docs. 2013-09-27 16:34:02 +02:00
STRWarrior
271bbdd7ac APIDump: Documented cServer 2013-09-27 15:10:55 +02:00
madmaxoft
aeb44b5e66 APIDump: Completed cCuboid docs. 2013-09-26 21:58:18 +02:00
madmaxoft
b4c7b18793 APIDump: Completed cCraftingGrid's documentation. 2013-09-26 21:37:15 +02:00
madmaxoft
1c0f47704f APIDump: completed cChestEntity docs. 2013-09-26 21:28:23 +02:00
madmaxoft
fe9be5b8be APIDump: Updated cBlockArea docs. 2013-09-25 09:15:48 +02:00
madmaxoft
6d1580bd39 APIDump: Updated cChunkDesc docs. 2013-09-25 09:03:53 +02:00
madmaxoft
8ca8c84ee5 APIDump: Updated cClientHandle documentation 2013-09-25 08:43:01 +02:00
madmaxoft
401e31fdc0 APIDump: Documented the cBoundingBox class. 2013-09-24 22:41:29 +02:00
STRWarrior
34f94cdc91 APIDump: Forgot a function in globals. 2013-09-22 15:54:33 +02:00
STRWarrior
636a0331f9 APIDump: Documented the globals. 2013-09-22 15:46:08 +02:00
madmaxoft
bc3447e4b2 APIDump: Automatic corrections. 2013-09-19 18:53:07 +02:00
madmaxoft
e8b70f8a0e APIDump: Updated cPluginManager documentation. 2013-09-18 21:33:55 +02:00
STRWarrior
fd52daec93 APIDump: Small cRoot improvement. 2013-09-18 12:04:07 +02:00
STRWarrior
a6e3933253 Documented cRoot. 2013-09-17 17:44:54 +02:00
madmaxoft
dd31eb9242 APIDump: Additional information is linkified, too. 2013-09-16 22:42:49 +02:00
madmaxoft
b1dc792259 APIDump: Added a slight visual style to <pre> tags 2013-09-16 22:34:27 +02:00
madmaxoft
8ad8a25c2f APIDump: Added callback examples to cWorld. 2013-09-16 11:44:12 +02:00
madmaxoft
8aacae5e37 APIDump: All cWorld functions are documented. 2013-09-16 10:16:04 +02:00
madmaxoft
7ecd728f1e APIDump: Next batch of cWorld documentation. 2013-09-15 22:30:17 +02:00
madmaxoft
f0ab45f65c APIDump: Added a first part of cWorld documentation. 2013-09-15 20:31:46 +02:00
madmaxoft
518e61e751 APIDump: Fixed linkification with multiple links in one string. 2013-09-15 20:29:42 +02:00
madmaxoft
b8a37c4f46 APIDump: Undescribed classes are listed as undocumented.
Previously class that was not listed in APIDesc was not listed in Undocumented.
2013-09-14 23:47:37 +02:00
madmaxoft
7ec598d8d4 APIDump: Added most missing classes as empty templates. 2013-09-14 23:36:55 +02:00
madmaxoft
2c7e7f24be APIDump: Removed most unexported-documented classes.
Also fixed most functions that were erroneously parsed as constants by the automatic wiki import.
2013-09-14 23:24:13 +02:00
madmaxoft
c3ad5bbf91 APIDump: Fixed dumping when APIDesc doesn't contain Constants section. 2013-09-14 23:21:10 +02:00
madmaxoft
57414e45b6 APIDump: Fixed cLuaWindow documentation. 2013-09-14 23:03:03 +02:00
madmaxoft
24daabdbfc APIDump: Added creating the list of unexported-documented API objects. 2013-09-14 22:34:19 +02:00
madmaxoft
66aee0ec68 APIDump: Implemented creating the list of undocumented API objects. 2013-09-14 22:15:58 +02:00
madmaxoft
62b74d0054 APIDump: Added a simple header to the class index. 2013-09-14 21:47:11 +02:00
madmaxoft
3ed9e148e8 APIDump: Added cArrowEntity documentation 2013-09-14 17:56:51 +02:00
madmaxoft
ec18331e66 APIDump: Added an example on how to fill in the documentation. 2013-09-14 17:43:06 +02:00
madmaxoft
85c4a1ebca APIDump: Added support for additional info exported with each class. 2013-09-14 17:28:22 +02:00
madmaxoft
de77eaaecd APIDump: Added support for overloaded functions. 2013-09-14 16:52:15 +02:00
madmaxoft
0b10f5f795 APIDump: Do not dump the g_APIDesc and APIDump's functions. 2013-09-14 16:27:12 +02:00
madmaxoft
d2c2d4ba52 APIDump: Moved sorting after the renaming. 2013-09-14 16:20:54 +02:00
madmaxoft
694878d2e8 APIDump: Linkifications works for simple {{link}} too. 2013-09-14 08:41:48 +02:00
madmaxoft
badacdb7c6 APIDump: Added special-function renaming (constructor, operators). 2013-09-14 08:38:39 +02:00
madmaxoft
efe0273c09 APIDump: Added more globally-ignored functions. 2013-09-14 08:31:34 +02:00
madmaxoft
024b080374 APIDump: Ignored functions are removed from undocumented classes, too. 2013-09-14 08:27:31 +02:00
madmaxoft
a9969408e4 APIDump: Ignoring some Lua internal stuff from API-scanning. 2013-09-13 16:38:39 +02:00
madmaxoft
ddda753f52 APIDump: Fixed link in cBlockArea's docs 2013-09-13 16:29:24 +02:00
madmaxoft
e3888bb147 APIDump: Basic CSS file makes tables visible 2013-09-13 16:26:17 +02:00
madmaxoft
d2deb381c2 APIDump: Constructors are renamed and can have documentation 2013-09-13 16:04:32 +02:00
madmaxoft
af8f7eb963 APIDump: Added support for ignoring functions; ignoring the lua/tolua internals. 2013-09-13 14:05:18 +02:00
madmaxoft
b91c4a0986 APIDump: Fixed cItem's description. 2013-09-13 11:22:52 +02:00
madmaxoft
9352af683d APIDump: Linkification works. 2013-09-13 11:22:27 +02:00
madmaxoft
24e70d534b APIDump: Added descendants specified through inheritance. 2013-09-13 10:51:01 +02:00
madmaxoft
1f1216d56d APIDump: Added support for inheritance 2013-09-13 10:22:04 +02:00
madmaxoft
80bdd2284b APIDump: Read through and fixed the first few classes desc. 2013-09-12 20:59:17 +02:00
madmaxoft
3109762e34 APIDump: Imported the descriptions from the wiki. 2013-09-12 20:38:30 +02:00
madmaxoft
69060f2656 APIDump: Fixed nesting 2013-09-12 20:29:31 +02:00
madmaxoft
435a8197c1 APIDump: Processing wiki-style bullets (" * ") into <li> tag 2013-09-12 20:17:26 +02:00
madmaxoft
b0c4f22e4c APIDump: Added parsing for older wiki format, "Class Definition" header. 2013-09-12 20:10:21 +02:00
madmaxoft
e9a809dfb9 APIDump: The APIDesc from wiki can be read back by Lua. 2013-09-12 19:52:47 +02:00
madmaxoft
5b8271517d APIDump: replacing wiki-style markup with APIDump-style markup 2013-09-12 18:57:21 +02:00
madmaxoft
f553d8e29e APIDump: Fixed parsing tables with wiki-links.
Also added real class name, description and constructor renaming.
2013-09-12 18:46:37 +02:00
madmaxoft
068708145b APIDump: Fixed a missing tab 2013-09-11 21:25:19 +02:00
madmaxoft
f845c1f72c APIDump: Added a testing constant description 2013-09-11 21:22:26 +02:00
madmaxoft
7dce0c276a APIDump: Initial implementation of wiki-to-lua conversion 2013-09-11 21:22:25 +02:00
madmaxoft
8012b8be6e APIDump: First attempt at outputting annotations in the HTML format 2013-09-11 16:57:57 +02:00
madmaxoft
410ba0e331 DumpAPI: Basic HTML output for classes 2013-09-10 22:03:10 +02:00
madmaxoft
a58cf6359d APIDump now produces wiki-style tables of functions and constants.
Part of #116.
2013-09-09 22:28:02 +02:00
Alexander Harkness
e57b4e1e59 Changed name and put the whitespace back, as per xoft's suggestion. 2013-07-30 16:26:06 +01:00
Alexander Harkness
23b9f83fac Moved the file to a more sensible name. 2013-07-30 16:24:13 +01:00