[Bf-blender-cvs] [905c816] master: Doxy comment for main()

[Campbell Barton]

Commit: 905c8168348bc67664dd90e45d2b0104fb3cfc2e
Author: Campbell Barton
Date:   Sun Mar 30 20:14:57 2014 +1100
https://developer.blender.org/rB905c8168348bc67664dd90e45d2b0104fb3cfc2e

Doxy comment for main()

===================================================================

M	source/creator/creator.c

===================================================================

diff --git a/source/creator/creator.c b/source/creator/creator.c
index 6cf86c4..249b18e 100644
--- a/source/creator/creator.c
+++ b/source/creator/creator.c
@@ -1478,12 +1478,21 @@ char **environ = NULL;
 #  endif
 #endif
 
-
+/**
+ * Blender's main function responsabilities are:
+ * - setup subsystems.
+ * - handle arguments.
+ * - run WM_main() event loop,
+ *   or exit when running in background mode.
+ */
+int main(
+       int argc,
 #ifdef WIN32
-int main(int argc, const char **UNUSED(argv_c)) /* Do not mess with const */
+        const char **UNUSED(argv_c)
 #else
-int main(int argc, const char **argv)
+        const char **argv
 #endif
+         )
 {
 	bContext *C;
 	SYS_SystemHandle syshandle;