Bladeren bron

changed ConsoleMethodEndWithDocs to ConsoleMethod[Group]EndWithDocs
tried a little trick to pull as much "old" Console function/method docs over as possible. Seems to work pretty well.

Charlie Patterson 12 jaren geleden
bovenliggende
commit
5d6efa98a5

+ 2 - 2
engine/source/2d/sceneobject/Trigger_ScriptBinding.h

@@ -22,7 +22,7 @@
 
 class Trigger;
 
-ConsoleMethodBeginWithDocs(Trigger)
+ConsoleMethodGroupBeginWithDocs(Trigger)
 
 /*! Set whether trigger checks onEnter events
 	@param setting Default is true.
@@ -102,4 +102,4 @@ ConsoleMethodWithDocs(Trigger, getLeaveCallback, ConsoleBool, 2, 2, ())
 
 //-----------------------------------------------------------------------------
 
-ConsoleMethodEndWithDocs(Trigger)
+ConsoleMethodGroupEndWithDocs(Trigger)

+ 2 - 2
engine/source/console/console.h

@@ -820,8 +820,8 @@ public:
 #  define ConsoleNamespace(className, usage) \
       static ConsoleConstructor className##__Namespace(#className, usage);
 
-#  define ConsoleMethodBeginWithDocs(className)
-#  define ConsoleMethodEndWithDocs(className)
+#  define ConsoleMethodGroupBeginWithDocs(className)
+#  define ConsoleMethodGroupEndWithDocs(className)
 
 #  define ConsoleMethodGroupBegin(className, groupName, usage) \
       static ConsoleConstructor className##groupName##__GroupBegin(#className,#groupName,usage);

+ 10 - 6
tools/documentation/config/torqueScriptReference.cfg

@@ -1613,11 +1613,13 @@ PREDEFINED            += ConsoleBool=bool
 # note: need a namespace to keep classes and global functions from being
 # hidden in the doc (due to the same name (for a different but related meaning) in the engine).
 
-PREDEFINED            += ConsoleFunctionGroupBegin(groupName,usage)=" "
+# PREDEFINED            += ConsoleFunctionGroupBegin(groupName,usage)=" "
+PREDEFINED            += ConsoleFunctionGroupBegin(groupName,usage)="namespace Functions { namespace groupName {"
 PREDEFINED            += ConsoleFunctionGroupBeginWithDocs(groupName)="namespace Functions { namespace groupName {"
 PREDEFINED            += ConsoleFunction(name,returnType,minArgs,maxArgs,usage1)="returnType name (...) "
 PREDEFINED            += ConsoleFunctionWithDocs(name,returnType,min,max,argString)="returnType name argString "
-PREDEFINED            += ConsoleFunctionGroupEnd(groupName)=" "
+# PREDEFINED            += ConsoleFunctionGroupEnd(groupName)=" "
+PREDEFINED            += ConsoleFunctionGroupEnd(groupName)="}; };"
 PREDEFINED            += ConsoleFunctionGroupEndWithDocs(groupName)="}; };"
 
 # T2D
@@ -1630,13 +1632,15 @@ PREDEFINED            += ConsoleFunctionGroupEndWithDocs(groupName)="}; };"
 # and "hides" it.  Therefore, we need a "different" Scene in TorqueScript so we use
 # namespace Class { Scene }.
 
-PREDEFINED            += ConsoleMethodGroupBegin(className,groupName,usage)=" "
-PREDEFINED            += ConsoleMethodBeginWithDocs(className)="namespace Class { class className { public:"
-PREDEFINED            += ConsoleMethod(className,name,returnType,minArgs,maxArgs,argString)="returnType className::name (...)"
+# PREDEFINED            += ConsoleMethodGroupBegin(className,groupName,usage)=" "
+PREDEFINED            += ConsoleMethodGroupBegin(className,groupName,usage)="namespace Class { class className { public:"
+PREDEFINED            += ConsoleMethodGroupBeginWithDocs(className)="namespace Class { class className { public:"
+# PREDEFINED            += ConsoleMethod(className,name,returnType,minArgs,maxArgs,argString)="returnType className::name (...)"
+PREDEFINED            += ConsoleMethod(className,name,returnType,minArgs,maxArgs,argString)="namespace Class { class className { public: returnType className::name (...); }; };"
 PREDEFINED            += ConsoleMethodWithDocs(className,name,returnType,minArgs,maxArgs,argString)="returnType className::name argString"
 PREDEFINED            += ConsoleStaticMethod(className,name,returnType,minArgs,maxArgs,argString)="static returnType className::name (...)"
 PREDEFINED            += ConsoleStaticMethodWithDocs(className,name,returnType,minArgs,maxArgs,argString)="static returnType className::name argString"
-PREDEFINED            += ConsoleMethodEndWithDocs(className)="}; };"
+PREDEFINED            += ConsoleMethodGroupEndWithDocs(className)="}; };"
 PREDEFINED            += ConsoleMethodGroupEnd(className,groupName)=" "
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then