Merge pull request #11180 from andyque/fix-comments

remove unneeded js & lua NA and remove deprecated list from navtree

cocos/base/CCAsyncTaskPool.h

@@ -38,13 +38,12 @@ THE SOFTWARE.
 #include <functional>
 #include <stdexcept>
 
-NS_CC_BEGIN
-/////////////////////////////////////////////////////////////////////////////
-
 /**
 * @addtogroup base
 * @{
 */
+NS_CC_BEGIN
+
 
 /**
  * @class AsyncTaskPool
@@ -213,8 +212,8 @@ inline void AsyncTaskPool::enqueue(AsyncTaskPool::TaskType type, const TaskCallB
     threadTask.enqueue(callback, callbackParam, f);
 }
 
-// end group
-/// @}
 
 NS_CC_END
+// end group
+/// @}
 #endif //__CCSYNC_TASK_POOL_H_

cocos/base/CCAutoreleasePool.h

@@ -29,14 +29,17 @@ THE SOFTWARE.
 #include <string>
 #include "base/CCRef.h"
 
-NS_CC_BEGIN
-
 /**
  * @addtogroup base
- * @js NA
  * @{
  */
+NS_CC_BEGIN
 
+
+/**
+ * A pool for managing autorlease objects.
+ * @js NA
+ */
 class CC_DLL AutoreleasePool
 {
 public:
@@ -144,7 +147,6 @@ private:
 /** @} */
 
 /**
- * @js NA 
  * @cond
  */
 class CC_DLL PoolManager

cocos/base/CCConfiguration.h

@@ -33,12 +33,12 @@ THE SOFTWARE.
 #include "base/CCValue.h"
 #include "platform/CCGL.h"
 
-NS_CC_BEGIN
-
 /**
  * @addtogroup base
  * @{
  */
+NS_CC_BEGIN
+
 /** @class Configuration
  * @brief Configuration contains some openGL variables
  * @since v0.99.0
@@ -234,9 +234,9 @@ protected:
 	ValueMap        _valueDict;
 };
 
+
+NS_CC_END
 // end of base group
 /// @}
 
-NS_CC_END
-
 #endif // __CCCONFIGURATION_H__

cocos/base/CCData.h

@@ -31,13 +31,13 @@
 #include <string>   // for ssize_t on linux
 #include "platform/CCStdC.h" // for ssize_t on window
 
-NS_CC_BEGIN
-
 /**
  * @addtogroup base
  * @js NA
  * @lua NA
  */
+NS_CC_BEGIN
+
 class CC_DLL Data
 {
 public:
@@ -126,8 +126,8 @@ private:
     ssize_t _size;
 };
 
-/** @} */
 
 NS_CC_END
 
+/** @} */
 #endif // __CCDATA_H__

cocos/base/CCIMEDelegate.h

@@ -29,11 +29,11 @@ THE SOFTWARE.
 #include <string>
 #include "math/CCGeometry.h"
 
-NS_CC_BEGIN
 /**
  * @addtogroup base
  * @{
  */
+NS_CC_BEGIN
 
 /**
  * A static global empty std::string install.
@@ -158,9 +158,9 @@ protected:
     IMEDelegate();
 };
 
+
+NS_CC_END
 // end of base group
 /// @}
 
-NS_CC_END
-
 #endif    // __CC_IME_DELEGATE_H__

cocos/base/CCIMEDispatcher.h

@@ -28,12 +28,12 @@ THE SOFTWARE.
 
 #include "base/CCIMEDelegate.h"
 
-NS_CC_BEGIN
-
 /**
  * @addtogroup base
  * @{
  */
+NS_CC_BEGIN
+
 
 /**
 @brief    Input Method Edit Message Dispatcher.
@@ -137,9 +137,9 @@ private:
     Impl * _impl;
 };
 
+
+NS_CC_END
 // end of base group
 /// @}
 
-NS_CC_END
-
 #endif    // __CC_IME_DISPATCHER_H__

cocos/base/CCMap.h

@@ -37,12 +37,12 @@
 #include <map>
 #endif
 
-NS_CC_BEGIN
 
 /**
  * @addtogroup base
  * @{
  */
+NS_CC_BEGIN
 
  /**
  * Similar to std::unordered_map, but it will manage reference count automatically internally.
@@ -416,9 +416,9 @@ protected:
     RefMap _data;
 };
 
+
+NS_CC_END
 // end group
 /// @}
 
-NS_CC_END
-
 #endif /* __CCMAP_H__ */

cocos/base/CCRef.h

@@ -31,12 +31,12 @@ THE SOFTWARE.
 
 #define CC_REF_LEAK_DETECTION 0
 
-NS_CC_BEGIN
-
 /**
  * @addtogroup base
  * @{
  */
+NS_CC_BEGIN
+
 
 class Ref;
 
@@ -190,9 +190,9 @@ typedef void (Ref::*SEL_SCHEDULE)(float);
 #define schedule_selector(_SELECTOR) CC_SCHEDULE_SELECTOR(_SELECTOR)
 
 
+
+NS_CC_END
 // end of base group
 /** @} */
 
-NS_CC_END
-
 #endif // __BASE_CCREF_H__

cocos/base/CCUserDefault.h

@@ -29,12 +29,12 @@ THE SOFTWARE.
 #include <string>
 #include "base/CCData.h"
 
-NS_CC_BEGIN
-
 /**
  * @addtogroup base
  * @{
  */
+NS_CC_BEGIN
+
 
 /**
  * UserDefault acts as a tiny database. You can save and get base type values by it.
@@ -243,9 +243,9 @@ private:
     static bool _isFilePathInitialized;
 };
 
+
+NS_CC_END
 // end of base group
 /** @} */
 
-NS_CC_END
-
 #endif // __SUPPORT_CCUSERDEFAULT_H__

cocos/base/CCValue.h

@@ -31,6 +31,11 @@
 #include <vector>
 #include <unordered_map>
 
+/**
+ * @addtogroup base
+ * @{
+ */
+
 NS_CC_BEGIN
 
 class Value;
@@ -43,8 +48,7 @@ CC_DLL extern const ValueVector ValueVectorNull;
 CC_DLL extern const ValueMap ValueMapNull;
 CC_DLL extern const ValueMapIntKey ValueMapIntKeyNull;
 
-/**
- * @addtogroup base
+/*
  * This class is provide as a wrapper of basic types, such as int and bool.
  */
 class CC_DLL Value

cocos/base/CCVector.h

@@ -32,10 +32,13 @@ THE SOFTWARE.
 #include <functional>
 #include <algorithm> // for std::find
 
-NS_CC_BEGIN
-
 /**
  * @addtogroup base
+ * @{
+ */
+NS_CC_BEGIN
+
+/*
  * Similar to std::vector, but it will manage reference count automatically internally.
  * Which means it will invoke Ref::retain() when adding an element, and invoke Ref::release() when removing an element.
  * @warn The element should be `Ref` or its sub-class.
@@ -499,7 +502,7 @@ protected:
     std::vector<T> _data;
 };
 
-// end of data_structure group
+// end of base group
 /** @} */
 
 NS_CC_END

cocos/base/ccRandom.h

@@ -31,12 +31,12 @@ THE SOFTWARE.
 
 #include "platform/CCPlatformMacros.h"
 
-NS_CC_BEGIN
-
 /**
 * @addtogroup base
 * @{
 */
+NS_CC_BEGIN
+
 
 /**
  * @class RandomHelper
@@ -119,8 +119,8 @@ inline float rand_0_1() {
 //    return cocos2d::random(0.f, 1.f);
 };
 
-// end group
-/// @}
 
 NS_CC_END
+// end group
+/// @}
 #endif //__ccRandom_H_

cocos/ui/UIButton.h

@@ -41,8 +41,6 @@ namespace ui{
     class Scale9Sprite;
 /**
  * Represents a push-button widget. Push-buttons can be pressed, or clicked, by the user to perform an action.
- *   @js NA
- *   @lua NA
  */
 class CC_GUI_DLL Button : public Widget
 {

cocos/ui/UICheckBox.h

@@ -58,8 +58,6 @@ typedef void (Ref::*SEL_SelectedStateEvent)(Ref*,CheckBoxEventType);
 
 /**
  *  Checkbox is a specific type of two-states button that can be either checked or unchecked.
- *   @js NA
- *   @lua NA
  */
 class CC_GUI_DLL CheckBox : public Widget
 {

cocos/ui/UIHelper.h

@@ -41,9 +41,9 @@ namespace ui {
     class Widget;
 
 /**
-*   @js NA
-*   @lua NA
-*/
+ * Helper class for traversing children in widget tree.
+ * It also provides some helper functions for layout.
+ */
 class CC_GUI_DLL Helper
 {
 public:

cocos/ui/UIImageView.h

@@ -38,8 +38,6 @@ namespace ui {
     class Scale9Sprite;
 /**
  * @brief A widget to display images.
- * @js NA
- * @lua NA
  */
 class CC_GUI_DLL ImageView : public Widget
 {

cocos/ui/UILayoutManager.h

@@ -44,8 +44,6 @@ class RelativeLayoutParameter;
 /**
  *@brief Base class for managing layout.
  * All the concret layout manager should inherit from this class.
- * @lua NA
- * @js NA
  */
 class CC_GUI_DLL LayoutManager : public Ref
 {

cocos/ui/UILayoutParameter.h

@@ -39,8 +39,6 @@ namespace ui {
 
 /**
  *@brief Margin of widget's in point. Margin value should be positive.
- *@lua NA
- *@js NA
  */
 class CC_GUI_DLL Margin
 {
@@ -119,8 +117,6 @@ public:
 
 /**
  *@brief Base class for various LayoutParameter.
- *@js NA
- *@lua NA
  */
 class CC_GUI_DLL LayoutParameter : public Ref
 {
@@ -205,8 +201,6 @@ protected:
 /**
  * Protocol for getting a LayoutParameter.
  * Every element want to have layout parameter should inherit from this class.
- *@js NA
- *@lua NA
  */
 class CC_GUI_DLL LayoutParameterProtocol
 {
@@ -227,8 +221,6 @@ public:
 /**
  * @brief Linear layout parameter.
  * It is used by linear layout manager for arranging elements linearly.
- * @js NA
- * @lua NA
  */
 class CC_GUI_DLL LinearLayoutParameter : public LayoutParameter
 {
@@ -296,8 +288,6 @@ protected:
 /**
  * @brief Relative layout parameter.
  * It is mainly used by  `RelativeLayoutManager`.
- * @lua NA
- * @js NA
  */
 class CC_GUI_DLL RelativeLayoutParameter : public LayoutParameter
 {

cocos/ui/UILoadingBar.h

@@ -40,8 +40,6 @@ namespace ui {
 /**
  *@brief Visual indicator of progress in some operation.
  * Displays a bar to the user representing how far the operation has progressed.
- *@js NA
- *@lua NA
  *
  */
 class CC_GUI_DLL LoadingBar : public Widget

cocos/ui/UIScrollView.h

@@ -64,7 +64,7 @@ typedef void (Ref::*SEL_ScrollViewEvent)(Ref*, ScrollviewEventType);
 
 /**
  * Layout container for a view hierarchy that can be scrolled by the user, allowing it to be larger than the physical display.
- * It holds a inner @see `Layout` container for storing child items hironzontally or vertically.
+ * It holds a inner `Layout` container for storing child items hironzontally or vertically.
  */
 class CC_GUI_DLL ScrollView : public Layout
 {

cocos/ui/UISlider.h

@@ -48,10 +48,8 @@ typedef enum
 typedef void (Ref::*SEL_SlidPercentChangedEvent)(Ref*,SliderEventType);
 #define sliderpercentchangedselector(_SELECTOR) (SEL_SlidPercentChangedEvent)(&_SELECTOR)
 
-/** @class Slider
+/** 
  * @brief UI Slider widget.
- *   @js NA
- *   @lua NA
  */
 class CC_GUI_DLL Slider : public Widget
 {

cocos/ui/UIText.h

@@ -41,8 +41,6 @@ namespace ui {
 
 /**
  *  For creating a system font or a TTF font Text
- *@js 
- *@lua NA
  */
 class CC_GUI_DLL Text : public Widget
 {

cocos/ui/UITextAtlas.h

@@ -39,10 +39,8 @@ class Label;
 
 namespace ui {
     
-/** @class TextAtlas
+/**
  * @brief UI TextAtlas widget.
- * @js NA
- * @lua NA
  */
 class CC_GUI_DLL TextAtlas : public Widget
 {

cocos/ui/UITextBMFont.h

@@ -40,8 +40,6 @@ namespace ui {
     
 /**
  * A widget for displaying BMFont label.
- *   @js NA
- *   @lua NA
  */    
 class CC_GUI_DLL TextBMFont : public Widget
 {

cocos/ui/UITextField.h

@@ -40,8 +40,6 @@ namespace ui {
 /**
  * @brief A helper class which inherit from @see `TextFieldTTF` and implements the @see `TextFieldDelegate` protocol.
  * It is mainly be used internally by @see `UITextField` class.
- *  @js NA
- *  @lua NA
  */
 class CC_GUI_DLL UICCTextField: public TextFieldTTF, public TextFieldDelegate
 {

cocos/ui/UIWebView.h

@@ -46,7 +46,6 @@ namespace experimental{
 class WebViewImpl;
 
 /**
- * @class WebView
  * @brief A View that displays web pages. 
  *
  * @note WebView displays web pages base on system widget.

cocos/ui/UIWidget.h

@@ -73,8 +73,6 @@ typedef void (Ref::*SEL_TouchEvent)(Ref*,TouchEventType);
  *@brief Base class for all ui widgets.
  * This class inherent from `ProtectedNode` and `LayoutParameterProtocol`.
  * If you want to implements your own ui widget, you should subclass it.
- * @js NA
- * @lua NA
  */
 class CC_GUI_DLL Widget : public ProtectedNode, public LayoutParameterProtocol
 {

docs/doxygen_white_book.config

@@ -600,7 +600,7 @@ GENERATE_BUGLIST       = YES
 # the documentation.
 # The default value is: YES.
 
-GENERATE_DEPRECATEDLIST= YES
+GENERATE_DEPRECATEDLIST= NO
 
 # The ENABLED_SECTIONS tag can be used to enable conditional documentation
 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
@@ -2032,6 +2032,7 @@ PREDEFINED             = "CC_PROPERTY_READONLY(varType, varName, funName)=protec
                          "CC_GUI_DLL=" \
                          "_USRDLL=" \
                          "_EXPORT_DLL_=" \
+                         "EXPORT_DLL_=" \
                          "_USEGUIDLL=" \
                          "_USREXDLL=" \
                          "_USRSTUDIODLL=" \