azerothcore/mod-ale
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Enhance documentation

Browse Source 
fix [] errors in types
fix int not set as basetype
add generated date to bottom of page
Rename Crates to All Classes and remove it from the class view
This commit is contained in:
Rochet2
2015-05-10 01:43:13 +03:00
parent 196a432e7d
commit f3cd70c401
9 changed files with 38 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/ElunaDoc/parser.py
View File

@@ -42,7 +42,7 @@ class ParameterDoc(object):
self.description = ''
# If the data type is a C++ number, convert to Lua number and add range info to description.
if self.data_type in ['float', 'double', 'int8', 'uint8', 'int16', 'uint16', 'int32', 'uint32']:
if self.data_type in ['float', 'double', 'int', 'int8', 'uint8', 'int16', 'uint16', 'int32', 'uint32']:
range = ParameterDoc.valid_ranges[self.data_type]
if range:
self.description += '<p><em>Valid numbers</em>: integers from {0} to {1}.</p>'.format(range[0], range[1])
@@ -57,6 +57,9 @@ class ParameterDoc(object):
elif self.data_type == 'int64' or self.data_type == 'uint64':
self.data_type = '[' + self.data_type + ']'
elif not self.data_type in ['nil', 'boolean', 'number', 'string', 'table', 'function', '...'] and self.data_type[:1] != '[':
print "Missing [] from data type `" + self.data_type + "`"
class MethodDoc(object):
"""The documentation data of an Eluna method."""