Cleanup: remove redundant doxygen \file argument
[blender.git] / intern / ghost / intern / GHOST_DropTargetX11.h
index b9e17dc..68d9c81 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  *
  * The Original Code is Copyright (C) 2012 by the Blender Foundation.
  * All rights reserved.
- *
- * The Original Code is: all of this file.
- *
- * Contributor(s): Sergey Sharybin.
- *
- * ***** END GPL LICENSE BLOCK *****
  */
 
-/** \file ghost/intern/GHOST_DropTargetWin32.h
- *  \ingroup GHOST
+/** \file \ingroup GHOST
  */
 
 #ifndef __GHOST_DROPTARGETX11_H__
@@ -44,10 +35,10 @@ public:
        /**
         * Constructor
         *
-        * @param window        The window to register as drop target.
-        * @param system        The associated system.
+        * \param window        The window to register as drop target.
+        * \param system        The associated system.
         */
-       GHOST_DropTargetX11(GHOST_WindowX11 * window, GHOST_SystemX11 * system);
+       GHOST_DropTargetX11(GHOST_WindowX11 *window, GHOST_SystemX11 *system);
 
        /**
         * Destructor
@@ -55,17 +46,17 @@ public:
        ~GHOST_DropTargetX11();
 
        /**
-         * Handler of ClientMessage X11 event
-         */
+        * Handler of ClientMessage X11 event
+        */
        bool GHOST_HandleClientMessage(XEvent *event);
 
        /**
         * Get data to pass in event.
         * It checks the type and calls specific functions for each type.
-        * @param dropType - type of dropped entity.
-        * @param dropBuffer - buffer returned from source application
-        * @param dropBufferSize - size of returned buffer
-        * @return Pointer to data.
+        * \param dropType - type of dropped entity.
+        * \param dropBuffer - buffer returned from source application
+        * \param dropBufferSize - size of returned buffer
+        * \return Pointer to data.
         */
        void *getGhostData(Atom dropType, unsigned char *dropBuffer, int dropBufferSize);
 
@@ -73,42 +64,42 @@ private:
        /* Internal helper functions */
 
        /**
-         * Initiailize XDND and all related X atoms
-         */
+        * Initialize XDND and all related X atoms
+        */
        void Initialize(void);
 
        /**
-         * Uninitiailize XDND and all related X atoms
-         */
+        * Uninitialize XDND and all related X atoms
+        */
        void Uninitialize(void);
 
        /**
-         * Get data to be passed to event from text/uri-list mime type
-         * @param dropBuffer - buffer returned from source application
-         * @param dropBufferSize - size of dropped buffer
-         * @return pointer to newly created GHOST data
-         */
-       void * getURIListGhostData(unsigned char *dropBuffer, int dropBufferSize);
+        * Get data to be passed to event from text/uri-list mime type
+        * \param dropBuffer - buffer returned from source application
+        * \param dropBufferSize - size of dropped buffer
+        * \return pointer to newly created GHOST data
+        */
+       void *getURIListGhostData(unsigned char *dropBuffer, int dropBufferSize);
 
        /**
-         * Decode URL (i.e. converts "file:///a%20b/test" to "file:///a b/test")
-         * @param decodedOut - buffer for decoded URL
-         * @param bufferSize - size of output buffer
-         * @param encodedIn - input encoded buffer to be decoded
-         */
+        * Decode URL (i.e. converts "file:///a%20b/test" to "file:///a b/test")
+        * \param decodedOut - buffer for decoded URL
+        * \param bufferSize - size of output buffer
+        * \param encodedIn - input encoded buffer to be decoded
+        */
        void UrlDecode(char *decodedOut, int bufferSize, const char *encodedIn);
 
        /**
-         * Fully decode file URL (i.e. converts "file:///a%20b/test" to "/a b/test")
-         * @param fileUrl - file path URL to be fully decoded
-         * @return decoded file path (resutl shold be free-d)
-         */
+        * Fully decode file URL (i.e. converts "file:///a%20b/test" to "/a b/test")
+        * \param fileUrl - file path URL to be fully decoded
+        * \return decoded file path (resutl should be free-d)
+        */
        char *FileUrlDecode(char *fileUrl);
 
        /* The associated GHOST_WindowWin32. */
-       GHOST_WindowX11 * m_window;
+       GHOST_WindowX11 *m_window;
        /* The System. */
-       GHOST_SystemX11 * m_system;
+       GHOST_SystemX11 *m_system;
 
        /* Data type of the dragged object */
        GHOST_TDragnDropTypes m_draggedObjectType;
@@ -120,16 +111,20 @@ private:
        static DndClass m_dndClass;
 
        /* list of supported types to eb draggeg into */
-       static Atom * m_dndTypes;
+       static Atom *m_dndTypes;
 
        /* list of supported dran'n'drop actions */
-       static Atom * m_dndActions;
+       static Atom *m_dndActions;
 
        /* List of supported MIME types to be dragged into */
        static const char *m_dndMimeTypes[];
 
        /* counter of references to global XDND structures */
        static int m_refCounter;
+
+#ifdef WITH_CXX_GUARDEDALLOC
+       MEM_CXX_CLASS_ALLOC_FUNCS("GHOST:GHOST_DropTargetX11")
+#endif
 };
 
 #endif  // __GHOST_DROPTARGETX11_H__