[m] Lots of Doxygen fixes/additions - thanks to lfxGroove

2025-12-27 10:37:02 +00:00 · 2013-06-23 21:43:27 +01:00 · 2013-06-23 21:43:27 +01:00 · c94dbc84c2
commit c94dbc84c2
parent b134615f92
960 changed files with 5905 additions and 6171 deletions
--- a/src/framework/CMakeLists.txt
+++ b/src/framework/CMakeLists.txt
@ -1,4 +1,3 @@
-#
 # This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 #
 # This program is free software; you can redistribute it and/or modify
@ -14,7 +13,6 @@
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#

 set(LIBRARY_NAME framework)

--- a/src/framework/Dynamic/FactoryHolder.h
+++ b/src/framework/Dynamic/FactoryHolder.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Dynamic/ObjectRegistry.h
+++ b/src/framework/Dynamic/ObjectRegistry.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/GameSystem/Grid.h
+++ b/src/framework/GameSystem/Grid.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/GameSystem/GridLoader.h
+++ b/src/framework/GameSystem/GridLoader.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
@ -19,7 +19,7 @@
 #ifndef MANGOS_GRIDLOADER_H
 #define MANGOS_GRIDLOADER_H

-/*
+/**
  @class GridLoader
  The GridLoader is working in conjuction with the Grid and responsible
  for loading and unloading object-types (one or more) when objects
--- a/src/framework/GameSystem/GridRefManager.h
+++ b/src/framework/GameSystem/GridRefManager.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/GameSystem/GridReference.h
+++ b/src/framework/GameSystem/GridReference.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/GameSystem/NGrid.h
+++ b/src/framework/GameSystem/NGrid.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/GameSystem/TypeContainer.h
+++ b/src/framework/GameSystem/TypeContainer.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/GameSystem/TypeContainerFunctions.h
+++ b/src/framework/GameSystem/TypeContainerFunctions.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/GameSystem/TypeContainerVisitor.h
+++ b/src/framework/GameSystem/TypeContainerVisitor.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Platform/CompilerDefs.h
+++ b/src/framework/Platform/CompilerDefs.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Platform/Define.h
+++ b/src/framework/Platform/Define.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Policies/CreationPolicy.h
+++ b/src/framework/Policies/CreationPolicy.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
@ -24,7 +24,7 @@

 namespace MaNGOS
 {
-    /*
+    /**
     * OperatorNew policy creates an object on the heap using new.
     */
    template<class T>
@ -43,7 +43,7 @@ namespace MaNGOS
            }
    };

-    /*
+    /**
     * LocalStaticCreation policy creates an object on the stack
     * the first time call Create.
     */
@ -78,7 +78,7 @@ namespace MaNGOS
            }
    };

-    /*
+    /**
     * CreateUsingMalloc by pass the memory manger.
     */
    template<class T>
@ -103,7 +103,7 @@ namespace MaNGOS
            }
    };

-    /*
+    /**
     * CreateOnCallBack creates the object base on the call back.
     */
    template<class T, class CALL_BACK>
--- a/src/framework/Policies/MemoryManagement.cpp
+++ b/src/framework/Policies/MemoryManagement.cpp
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Policies/ObjectLifeTime.cpp
+++ b/src/framework/Policies/ObjectLifeTime.cpp
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Policies/ObjectLifeTime.h
+++ b/src/framework/Policies/ObjectLifeTime.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Policies/Singleton.h
+++ b/src/framework/Policies/Singleton.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
@ -19,7 +19,7 @@
 #ifndef MANGOS_SINGLETON_H
 #define MANGOS_SINGLETON_H

-/*
+/**
 * @brief class Singleton
 */

--- a/src/framework/Policies/ThreadingModel.h
+++ b/src/framework/Policies/ThreadingModel.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
@ -19,7 +19,7 @@
 #ifndef MANGOS_THREADINGMODEL_H
 #define MANGOS_THREADINGMODEL_H

-/*
+/**
 * @class ThreadingModel<T>
 *
 */
--- a/src/framework/Utilities/ByteConverter.h
+++ b/src/framework/Utilities/ByteConverter.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Utilities/Callback.h
+++ b/src/framework/Utilities/Callback.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Utilities/EventProcessor.cpp
+++ b/src/framework/Utilities/EventProcessor.cpp
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Utilities/EventProcessor.h
+++ b/src/framework/Utilities/EventProcessor.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Utilities/LinkedList.h
+++ b/src/framework/Utilities/LinkedList.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Utilities/LinkedReference/RefManager.h
+++ b/src/framework/Utilities/LinkedReference/RefManager.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Utilities/LinkedReference/Reference.h
+++ b/src/framework/Utilities/LinkedReference/Reference.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Utilities/TypeList.h
+++ b/src/framework/Utilities/TypeList.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify
--- a/src/framework/Utilities/UnorderedMapSet.h
+++ b/src/framework/Utilities/UnorderedMapSet.h
@ -1,4 +1,4 @@
-/*
+/**
 * This code is part of MaNGOS. Contributor & Copyright details are in AUTHORS/THANKS.
 *
 * This program is free software; you can redistribute it and/or modify