Permalink
Browse files

Fix #423 (Switch from CppDoc to Doxygen), based on patch from anr.

Also delete some unused declarations, and rename is_playing to snd_is_playing.


git-svn-id: http://svn.wildfiregames.com/public/ps/trunk@7813 3db68df2-c116-0410-a063-a993310a9797
  • Loading branch information...
1 parent 769f783 commit 694da5354e93000a67ad2421d13d18c038f25974 philip committed Jul 29, 2010
Showing with 451 additions and 407 deletions.
  1. +8 −4 docs/doxygen/config
  2. +2 −2 source/collada/CommonConvert.h
  3. +4 −2 source/collada/StdSkeletons.h
  4. +2 −1 source/graphics/ColladaManager.h
  5. +1 −1 source/graphics/UnitManager.cpp
  6. +5 −4 source/gui/CGUI.h
  7. +1 −1 source/gui/CGUISprite.h
  8. +1 −1 source/gui/CList.h
  9. +2 −3 source/gui/GUIbase.h
  10. +4 −5 source/gui/GUItext.h
  11. +3 −2 source/gui/GUIutil.h
  12. +3 −22 source/gui/IGUIObject.h
  13. +13 −15 source/gui/IGUIScrollBar.h
  14. +1 −0 source/gui/IGUITextOwner.h
  15. +0 −1 source/gui/scripting/JSInterface_GUITypes.cpp
  16. +9 −9 source/lib/allocators/allocators.h
  17. +5 −5 source/lib/allocators/bucket.h
  18. +3 −3 source/lib/allocators/dynarray.h
  19. +8 −7 source/lib/allocators/pool.h
  20. +3 −3 source/lib/base32.h
  21. +6 −6 source/lib/bits.h
  22. +4 −4 source/lib/byte_order.h
  23. +6 −12 source/lib/code_annotation.h
  24. +20 −20 source/lib/debug.h
  25. +5 −5 source/lib/debug_stl.h
  26. +3 −1 source/lib/file/archive/archive_zip.cpp
  27. +12 −6 source/lib/file/archive/codec.h
  28. +1 −1 source/lib/file/common/trace.h
  29. +14 −10 source/lib/file/file_system_util.h
  30. +4 −3 source/lib/file/io/block_cache.h
  31. +5 −3 source/lib/file/vfs/file_cache.h
  32. +17 −12 source/lib/file/vfs/vfs.h
  33. +4 −4 source/lib/file/vfs/vfs_lookup.h
  34. +4 −4 source/lib/path_util.h
  35. +9 −8 source/lib/res/graphics/cursor.h
  36. +4 −2 source/lib/res/graphics/ogl_shader.h
  37. +20 −14 source/lib/res/graphics/ogl_tex.h
  38. +9 −3 source/lib/res/graphics/unifont.h
  39. +24 −25 source/lib/res/sound/snd_mgr.cpp
  40. +76 −66 source/lib/res/sound/snd_mgr.h
  41. +6 −5 source/lib/sysdep/arch/x86_x64/topology.cpp
  42. +2 −2 source/lib/sysdep/arch/x86_x64/topology.h
  43. +8 −8 source/lib/sysdep/cursor.h
  44. +6 −3 source/lib/sysdep/numa.h
  45. +7 −4 source/lib/sysdep/os/win/wdbg_sym.h
  46. +6 −5 source/lib/sysdep/os/win/wdll_ver.h
  47. +5 −3 source/lib/sysdep/os/win/whrt/counter.cpp
  48. +1 −1 source/lib/sysdep/os/win/whrt/counter.h
  49. +1 −1 source/lib/sysdep/os/win/wposix/crt_posix.h
  50. +2 −2 source/lib/sysdep/os/win/wposix/no_crt_posix.h
  51. +3 −3 source/lib/sysdep/os/win/wposix/wposix.h
  52. +3 −1 source/lib/sysdep/os/win/wseh.cpp
  53. +10 −9 source/lib/sysdep/sysdep.h
  54. +44 −39 source/lib/tex/tex.h
  55. +2 −1 source/lib/tex/tex_codec.h
  56. +1 −1 source/lib/timer.h
  57. +2 −2 source/maths/scripting/JSInterface_Vector3D.h
  58. +1 −1 source/ps/FileIo.cpp
  59. +2 −2 source/ps/Game.cpp
  60. +1 −1 source/ps/Game.h
  61. +1 −1 source/ps/Overlay.cpp
  62. +1 −1 source/ps/World.cpp
  63. +1 −2 source/renderer/TerrainRenderer.h
  64. +1 −1 source/renderer/TransparencyRenderer.cpp
  65. +1 −0 source/simulation2/components/ICmpObstructionManager.h
  66. +5 −5 source/simulation2/serialization/ISerializer.h
  67. +3 −3 source/sound/SoundGroup.cpp
View
@@ -3,12 +3,12 @@ PROJECT_NUMBER = trunk
TAB_SIZE = 4
-INPUT = ../../source/simulation2 ../../source/scriptinterface ../../source/network ../../source/gui
+INPUT = ../../source
INCLUDE_PATH = ../../source
EXAMPLE_PATH = ../../source
RECURSIVE = YES
EXCLUDE_PATTERNS = */.svn* */tests/test_*
-EXCLUDE = ../../source/dcdt ../../source/tools ../../source/i18n/tests2
+EXCLUDE = ../../source/tools ../../source/i18n/tests2 ../../source/simulation
JAVADOC_AUTOBRIEF = YES
@@ -23,6 +23,10 @@ GENERATE_LATEX = NO
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
-PREDEFINED = "UNUSED(x)=x"
+PREDEFINED = "UNUSED(x)=x" \
+ "METHODDEF(x)=static x" \
+ "GLOBAL(x)=x"
EXPAND_AS_DEFINED += DEFAULT_COMPONENT_ALLOCATOR DEFAULT_SCRIPT_WRAPPER DEFAULT_INTERFACE_WRAPPER DEFAULT_MESSAGE_IMPL
-EXPAND_AS_DEFINED += MESSAGE INTERFACE COMPONENT
+EXPAND_AS_DEFINED += MESSAGE INTERFACE COMPONENT GUISTDTYPE
+
+WARN_LOGFILE = doxygen.log
@@ -66,7 +66,7 @@ class FColladaErrorHandler
/**
* Standard document loader. Based on FCDocument::LoadFromText, but allows
- * access to <extra> nodes at the document level (i.e. directly in <COLLADA>).
+ * access to \<extra\> nodes at the document level (i.e. directly in \<COLLADA\>).
*/
class FColladaDocument
{
@@ -81,7 +81,7 @@ class FColladaDocument
/** Returns the FCDocument that was loaded. */
FCDocument* GetDocument() const { return document.get(); }
- /** Returns the <extra> data from the <COLLADA> element. */
+ /** Returns the \<extra\> data from the \<COLLADA\> element. */
FCDExtra* GetExtra() const { return extra.get(); }
private:
@@ -84,9 +84,11 @@ class Skeleton
/**
* Initialises the global state with skeleton data loaded from the
* given XML data. Must only be called once.
- * (TODO: stop using global state.)
+ * @todo Stop using global state.
+ * @param xmlData
+ * @param xmlLength
* @param xmlErrors output - XML parser error messages; will be non-empty
- * on failure (and failure will always throw)
+ * on failure (and failure will always throw)
* @throws ColladaException on failure
*/
static void LoadSkeletonDataFromXml(const char* xmlData, size_t xmlLength, std::string& xmlErrors);
@@ -36,7 +36,8 @@ class CColladaManager
* Performs a (cached) conversion from COLLADA if necessary.
*
* @param pathnameNoExtension path and name, minus extension, of file to load.
- * One of either "sourceName.pmd" or "sourceName.dae" should exist.
+ * One of either "sourceName.pmd" or "sourceName.dae" should exist.
+ * @param type FileType, .pmd or .psa
*
* @return full VFS path (including extension) of file to load; or empty
* string if there was a problem and it could not be loaded.
@@ -125,7 +125,7 @@ CUnit* CUnitManager::PickUnit(const CVector3D& origin, const CVector3D& dir, boo
///////////////////////////////////////////////////////////////////////////////
// CreateUnit: create a new unit and add it to the world
-CUnit* CUnitManager::CreateUnit(const CStrW& actorName, const std::set<CStr>& selections)
+CUnit* CUnitManager::CreateUnit(const CStrW& actorName, const std::set<CStr8>& selections)
{
if (! m_ObjectManager)
return NULL;
View
@@ -155,6 +155,7 @@ class CGUI
* @param DefaultColor Color used if no tag applied.
* @param pos position
* @param z z value.
+ * @param clipping
*/
void DrawText(SGUIText &Text, const CColor &DefaultColor,
const CPos &pos, const float &z, const CRect &clipping);
@@ -242,10 +243,8 @@ class CGUI
* can be changed by tags.
* @param Width Width, 0 if no word-wrapping.
* @param BufferZone space between text and edge, and space between text and images.
- *
- * pObject is *only* if error parsing fails, and we need to be able to output
- * which object the error occured in to aid the user. The parameter is completely
- * optional.
+ * @param pObject Optional parameter for error output. Used *only* if error parsing fails,
+ * and we need to be able to output which object the error occured in to aid the user.
*/
SGUIText GenerateText(const CGUIString &Text, const CStr& Font,
const float &Width, const float &BufferZone,
@@ -370,6 +369,7 @@ class CGUI
* @param Element The Xeromyces object that represents
* the objects-tag.
* @param pFile The Xeromyces object for the file being read
+ * @param Paths Collects the set of all XML/JS files that are loaded
*
* @see LoadXmlFile()
*/
@@ -448,6 +448,7 @@ class CGUI
* @param Element The Xeromyces object that represents
* the script-tag.
* @param pFile The Xeromyces object for the file being read
+ * @param Paths Output set of file paths that this script is loaded from.
*
* @see LoadXmlFile()
*/
@@ -120,7 +120,7 @@ struct SGUIImage
/**
* The GUI sprite, is actually several real sprites (images)
- * like a collage. View the section <sprites> in the GUI
+ * like a collage. View the section \<sprites\> in the GUI
* TDD for more information.
*
* Drawing routine is located in CGUI
View
@@ -111,7 +111,7 @@ class CList : public IGUIScrollBarOwner, public IGUITextOwner
virtual void SelectLastElement();
/**
- * Handle the <item> tag.
+ * Handle the \<item\> tag.
*/
virtual bool HandleAdditionalChildren(const XMBElement& child, CXeromyces* pFile);
@@ -67,10 +67,9 @@ public: \
//--------------------------------------------------------
// Types
//--------------------------------------------------------
+
/**
- * @enum EGUIMessage
- * Message types
- *
+ * Message types.
* @see SGUIMessage
*/
enum EGUIMessageType
@@ -291,11 +291,10 @@ class CGUIString
* @param from From character n,
* @param to to character n.
* @param FirstLine Whether this is the first line of text, to calculate its height correctly
- *
- * pObject Only for Error outputting, optional! If NULL
- * then no Errors will be reported! Useful when you need
- * to make several GenerateTextCall in different phases,
- * it avoids duplicates.
+ * @param pObject Only for Error outputting, optional! If NULL
+ * then no Errors will be reported! Useful when you need
+ * to make several GenerateTextCall in different phases,
+ * it avoids duplicates.
*/
void GenerateTextCall(SFeedback &Feedback,
const CStr& DefaultFont,
@@ -140,7 +140,7 @@ class GUI : public CInternalCGUIAccessorBase
/**
* Retrieves a setting by settings name and object name
*
- * @param GUI GUI Object const ref
+ * @param GUIinstance GUI Object const ref
* @param Object Object name
* @param Setting Setting by name
* @param Value Stores value here, note type T!
@@ -165,10 +165,11 @@ class GUI : public CInternalCGUIAccessorBase
* This is just a wrapper so that we can type the object name
* and not input the actual pointer.
*
- * @param GUI GUI Object, reference since we'll be changing values
+ * @param GUIinstance GUI Object, reference since we'll be changing values
* @param Object Object name
* @param Setting Setting by name
* @param Value Sets value to this, note type T!
+ * @param SkipMessage Does not send a GUIM_SETTINGS_UPDATED if true
*/
static PSRETURN SetSetting(
CGUI &GUIinstance, const CStr& Object,
@@ -256,21 +256,15 @@ class IGUIObject
void CheckSettingsValidity();
/**
- * Sets up a map_size_t to include the variables in m_BaseSettings
- *
- * @param SettingsInfo Pointers that should be filled with base variables
- */
- //void SetupBaseSettingsInfo(map_Settings &SettingsInfo);
-
- /**
* Set a setting by string, regardless of what type it is.
*
* example a CRect(10,10,20,20) would be "10 10 20 20"
*
* @param Setting Setting by name
* @param Value Value to set to
+ * @param SkipMessage Does not send a GUIM_SETTINGS_UPDATED if true
*
- * @return PSERROR (PSRETURN_OK if successful)
+ * @return PSRETURN (PSRETURN_OK if successful)
*/
PSRETURN SetSetting(const CStr& Setting, const CStrW& Value, const bool& SkipMessage=false);
@@ -414,19 +408,6 @@ class IGUIObject
IGUIObject *GetParent() const;
/**
- * Same as reference, but returns a const
- */
-// IGUIObject const *GetParent() const;
-
- /**
- * You input the setting struct you want, and it will return a pointer to
- * the struct.
- *
- * @param SettingsStruct tells us which pointer ot return
- */
- //virtual void *GetStructPointer(const EGUISettingsStruct &SettingsStruct) const;
-
- /**
* Get Mouse from CGUI.
*/
CPos GetMousePos() const;
@@ -500,7 +481,7 @@ class IGUIObject
*
* @return the error result
*/
- PSRETURN LogInvalidSettings(const CStr& Setting) const;
+ PSRETURN LogInvalidSettings(const CStr8& Setting) const;
// Variables
@@ -177,17 +177,15 @@ class IGUIScrollBar
/**
* Hovering the scroll minus button
*
- * @param m_x mouse x
- * @param m_y mouse y
+ * @param mouse current mouse position
* @return True if mouse positions are hovering the button
*/
virtual bool HoveringButtonMinus(const CPos& UNUSED(mouse)) { return false; }
/**
* Hovering the scroll plus button
*
- * @param m_x mouse x
- * @param m_y mouse y
+ * @param mouse current mouse position
* @return True if mouse positions are hovering the button
*/
virtual bool HoveringButtonPlus(const CPos& UNUSED(mouse)) { return false; }
@@ -200,7 +198,7 @@ class IGUIScrollBar
/**
* Set scroll-position by hand
*/
- virtual void SetPos(const float &f) { m_Pos = f; UpdatePosBoundaries(); }
+ virtual void SetPos(float f) { m_Pos = f; UpdatePosBoundaries(); }
/**
* Get the value of Pos that corresponds to the bottom of the scrollable region
@@ -249,55 +247,55 @@ class IGUIScrollBar
* Set Width
* @param width Width
*/
- void SetWidth(const float &width) { m_Width = width; }
+ void SetWidth(float width) { m_Width = width; }
/**
* Set X Position
* @param x Position in this axis
*/
- void SetX(const float &x) { m_X = x; }
+ void SetX(float x) { m_X = x; }
/**
* Set Y Position
* @param y Position in this axis
*/
- void SetY(const float &y) { m_Y = y; }
+ void SetY(float y) { m_Y = y; }
/**
* Set Z Position
* @param z Position in this axis
*/
- void SetZ(const float &z) { m_Z = z; }
+ void SetZ(float z) { m_Z = z; }
/**
* Set Length of scroll bar
* @param length Length
*/
- void SetLength(const float &length) { m_Length = length; }
+ void SetLength(float length) { m_Length = length; }
/**
* Set content length
* @param range Maximum scrollable range
*/
- void SetScrollRange(const float &range) { m_ScrollRange = std::max(range, 1.f); SetupBarSize(); UpdatePosBoundaries(); }
+ void SetScrollRange(float range) { m_ScrollRange = std::max(range, 1.f); SetupBarSize(); UpdatePosBoundaries(); }
/**
* Set space that is visible in the scrollable control.
* @param space Visible area in the scrollable control.
*/
- void SetScrollSpace(const float &space) { m_ScrollSpace = space; SetupBarSize(); UpdatePosBoundaries(); }
+ void SetScrollSpace(float space) { m_ScrollSpace = space; SetupBarSize(); UpdatePosBoundaries(); }
/**
* Set bar pressed
- * @param pressed True if bar is pressed
+ * @param b True if bar is pressed
*/
- void SetBarPressed(const bool &b) { m_BarPressed = b; }
+ void SetBarPressed(bool b) { m_BarPressed = b; }
/**
* Set use edge buttons
* @param b True if edge buttons should be used
*/
- void SetUseEdgeButtons(const bool &b) { m_UseEdgeButtons = b; }
+ void SetUseEdgeButtons(bool b) { m_UseEdgeButtons = b; }
/**
* Set Scroll bar style string
@@ -82,6 +82,7 @@ class IGUITextOwner : virtual public IGUIObject
* Draws the Text.
*
* @param index Index value of text. Mostly this will be 0
+ * @param color
* @param pos Position
* @param z Z value
* @param clipping Clipping rectangle, don't even add a parameter
@@ -21,7 +21,6 @@
#include "ps/CStr.h"
/**** GUISize ****/
-
JSClass JSI_GUISize::JSI_class = {
"GUISize", 0,
JS_PropertyStub, JS_PropertyStub,
Oops, something went wrong.

0 comments on commit 694da53

Please sign in to comment.