From f41b18f0649a50e179ba41383f4061e1878c4d4c Mon Sep 17 00:00:00 2001 From: Thomas Geymayer Date: Tue, 29 Jul 2014 23:04:45 +0200 Subject: [PATCH] Improve (mostly Canvas event related) documentation. --- Doxyfile | 2 +- simgear/canvas/Canvas.hxx | 6 +++- simgear/canvas/CanvasEvent.cxx | 2 +- simgear/canvas/CanvasEvent.hxx | 18 +++++++--- simgear/canvas/CanvasEventTypes.hxx | 26 +++++++-------- simgear/canvas/CanvasObjectPlacement.hxx | 9 ++--- simgear/canvas/elements/CanvasElement.hxx | 5 +-- simgear/canvas/events/CustomEvent.hxx | 7 +++- simgear/canvas/events/DeviceEvent.hxx | 14 +++++++- simgear/canvas/events/KeyboardEvent.hxx | 6 +++- simgear/canvas/events/MouseEvent.hxx | 6 +++- simgear/canvas/layout/BoxLayout.hxx | 7 +++- simgear/canvas/layout/Layout.hxx | 5 ++- simgear/canvas/layout/LayoutItem.hxx | 3 +- simgear/canvas/layout/NasalWidget.hxx | 5 +-- simgear/canvas/layout/SpacerItem.hxx | 2 +- simgear/io/HTTPFileRequest.hxx | 5 ++- simgear/io/HTTPMemoryRequest.hxx | 5 ++- simgear/io/HTTPRequest.cxx | 17 ++++++++++ simgear/io/HTTPRequest.hxx | 22 ++++++++++++ simgear/misc/SVGpreserveAspectRatio.hxx | 4 ++- simgear/misc/SimpleMarkdown.hxx | 3 +- simgear/nasal/cppbind/NasalContext.hxx | 5 ++- simgear/nasal/cppbind/NasalHash.hxx | 4 +-- simgear/nasal/cppbind/NasalObject.hxx | 5 ++- simgear/nasal/cppbind/NasalObjectHolder.hxx | 3 +- simgear/nasal/cppbind/NasalString.hxx | 4 +-- simgear/props/easing_functions.cxx | 37 ++++++++++++++++----- simgear/structure/function_list.hxx | 7 +++- simgear/structure/map.hxx | 5 ++- 30 files changed, 192 insertions(+), 57 deletions(-) diff --git a/Doxyfile b/Doxyfile index 0017d442..f4aa9c6c 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1923,7 +1923,7 @@ ENABLE_PREPROCESSING = YES # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -MACRO_EXPANSION = NO +MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then # the macro expansion is limited to the macros specified with the PREDEFINED and diff --git a/simgear/canvas/Canvas.hxx b/simgear/canvas/Canvas.hxx index 8501b504..42c28632 100644 --- a/simgear/canvas/Canvas.hxx +++ b/simgear/canvas/Canvas.hxx @@ -1,4 +1,5 @@ -///@file The canvas for rendering with the 2d API +///@file +/// The canvas for rendering with the 2d API // // Copyright (C) 2012 Thomas Geymayer // @@ -43,6 +44,9 @@ namespace canvas class CanvasMgr; class MouseEvent; + /** + * Canvas to draw onto (to an off-screen render target). + */ class Canvas: public PropertyBasedElement, public nasal::Object diff --git a/simgear/canvas/CanvasEvent.cxx b/simgear/canvas/CanvasEvent.cxx index 6c2684bc..44786551 100644 --- a/simgear/canvas/CanvasEvent.cxx +++ b/simgear/canvas/CanvasEvent.cxx @@ -125,7 +125,7 @@ namespace canvas if( type_map.empty() ) { -# define ENUM_MAPPING(type, str)\ +# define ENUM_MAPPING(type, str, class_name)\ type_map.insert(TypeMap::value_type(str, type)); # include "CanvasEventTypes.hxx" # undef ENUM_MAPPING diff --git a/simgear/canvas/CanvasEvent.hxx b/simgear/canvas/CanvasEvent.hxx index 6d81d134..92ccdf19 100644 --- a/simgear/canvas/CanvasEvent.hxx +++ b/simgear/canvas/CanvasEvent.hxx @@ -1,4 +1,5 @@ -// Canvas Event for event model similar to DOM Level 3 Event Model +/// @file +/// Canvas Event for event model similar to DOM Level 3 Event Model // // Copyright (C) 2012 Thomas Geymayer // @@ -27,19 +28,28 @@ namespace simgear namespace canvas { + /** + * Base class for all Canvas events. + * + * The event system is closely following the specification of the DOM Level 3 + * Event Model. + */ class Event: public SGReferenced { public: + /// Event type identifier enum Type { UNKNOWN, -# define ENUM_MAPPING(name, str) name, +# define ENUM_MAPPING(name, str, class_name)\ + name, /*!< class_name (type=str) */ # include "CanvasEventTypes.hxx" # undef ENUM_MAPPING - CUSTOM_EVENT ///< all user defined event types share the same id. They - /// are just differentiated by using the type string. + CUSTOM_EVENT ///< First event type id available for user defined event + /// type. + /// @see CustomEvent }; int type; diff --git a/simgear/canvas/CanvasEventTypes.hxx b/simgear/canvas/CanvasEventTypes.hxx index 5f36ba1c..8003b7cb 100644 --- a/simgear/canvas/CanvasEventTypes.hxx +++ b/simgear/canvas/CanvasEventTypes.hxx @@ -20,16 +20,16 @@ # error "Don't include this file directly!" #endif -ENUM_MAPPING(MOUSE_DOWN, "mousedown") -ENUM_MAPPING(MOUSE_UP, "mouseup") -ENUM_MAPPING(CLICK, "click") -ENUM_MAPPING(DBL_CLICK, "dblclick") -ENUM_MAPPING(DRAG, "drag") -ENUM_MAPPING(WHEEL, "wheel") -ENUM_MAPPING(MOUSE_MOVE, "mousemove") -ENUM_MAPPING(MOUSE_OVER, "mouseover") -ENUM_MAPPING(MOUSE_OUT, "mouseout") -ENUM_MAPPING(MOUSE_ENTER, "mouseenter") -ENUM_MAPPING(MOUSE_LEAVE, "mouseleave") -ENUM_MAPPING(KEY_DOWN, "keydown") -ENUM_MAPPING(KEY_UP, "keyup") +ENUM_MAPPING(MOUSE_DOWN, "mousedown", MouseEvent) +ENUM_MAPPING(MOUSE_UP, "mouseup", MouseEvent) +ENUM_MAPPING(CLICK, "click", MouseEvent) +ENUM_MAPPING(DBL_CLICK, "dblclick", MouseEvent) +ENUM_MAPPING(DRAG, "drag", MouseEvent) +ENUM_MAPPING(WHEEL, "wheel", MouseEvent) +ENUM_MAPPING(MOUSE_MOVE, "mousemove", MouseEvent) +ENUM_MAPPING(MOUSE_OVER, "mouseover", MouseEvent) +ENUM_MAPPING(MOUSE_OUT, "mouseout", MouseEvent) +ENUM_MAPPING(MOUSE_ENTER, "mouseenter", MouseEvent) +ENUM_MAPPING(MOUSE_LEAVE, "mouseleave", MouseEvent) +ENUM_MAPPING(KEY_DOWN, "keydown", KeyboardEvent) +ENUM_MAPPING(KEY_UP, "keyup", KeyboardEvent) diff --git a/simgear/canvas/CanvasObjectPlacement.hxx b/simgear/canvas/CanvasObjectPlacement.hxx index d2e2bee7..a97aeb6e 100644 --- a/simgear/canvas/CanvasObjectPlacement.hxx +++ b/simgear/canvas/CanvasObjectPlacement.hxx @@ -1,7 +1,8 @@ -///@file Placement for putting a canvas texture onto OpenSceneGraph objects. -// -// It also provides a SGPickCallback for passing mouse events to the canvas and -// manages emissive lighting of the placed canvas. +///@file +/// Placement for putting a canvas texture onto OpenSceneGraph objects. +/// +/// It also provides a SGPickCallback for passing mouse events to the canvas and +/// manages emissive lighting of the placed canvas. // // Copyright (C) 2013 Thomas Geymayer // diff --git a/simgear/canvas/elements/CanvasElement.hxx b/simgear/canvas/elements/CanvasElement.hxx index 242c2202..a0d2bb18 100644 --- a/simgear/canvas/elements/CanvasElement.hxx +++ b/simgear/canvas/elements/CanvasElement.hxx @@ -1,4 +1,5 @@ -///@file Interface for 2D Canvas elements +///@file +/// Interface for 2D Canvas elements // // Copyright (C) 2012 Thomas Geymayer // @@ -42,7 +43,7 @@ namespace canvas { /** - * Baseclass for Elements displayed inside a Canvas. + * Base class for Elements displayed inside a Canvas. */ class Element: public PropertyBasedElement diff --git a/simgear/canvas/events/CustomEvent.hxx b/simgear/canvas/events/CustomEvent.hxx index 1117ba3f..524f4e67 100644 --- a/simgear/canvas/events/CustomEvent.hxx +++ b/simgear/canvas/events/CustomEvent.hxx @@ -1,4 +1,5 @@ -///@file Canvas user defined event +///@file +/// Canvas user defined event // // Copyright (C) 2014 Thomas Geymayer // @@ -27,6 +28,10 @@ namespace simgear namespace canvas { + /** + * User defined event (optionally carrying additional context information or + * data). + */ class CustomEvent: public Event { diff --git a/simgear/canvas/events/DeviceEvent.hxx b/simgear/canvas/events/DeviceEvent.hxx index 8fc366a3..14d2aa4d 100644 --- a/simgear/canvas/events/DeviceEvent.hxx +++ b/simgear/canvas/events/DeviceEvent.hxx @@ -1,4 +1,5 @@ -///@file Input device event (keyboard/mouse) +///@file +/// Input device event (keyboard/mouse) // // Copyright (C) 2014 Thomas Geymayer // @@ -35,14 +36,25 @@ namespace canvas public Event { public: + /// Default initialization (no active keyboard modifier). DeviceEvent(); + + /// Initialize from an OpenSceneGraph event. DeviceEvent(const osgGA::GUIEventAdapter& ea); + /// Get mask of active keyboard modifiers at the time of the event. int getModifiers() const { return modifiers; } + /// Get if a Ctrl modifier was active. bool ctrlKey() const; + + /// Get if a Shift modifier was active. bool shiftKey() const; + + /// Get if an Alt modifier was active. bool altKey() const; + + /// Get if a Meta modifier was active. bool metaKey() const; protected: diff --git a/simgear/canvas/events/KeyboardEvent.hxx b/simgear/canvas/events/KeyboardEvent.hxx index d90a9246..385590c8 100644 --- a/simgear/canvas/events/KeyboardEvent.hxx +++ b/simgear/canvas/events/KeyboardEvent.hxx @@ -1,4 +1,5 @@ -///@file Keyboard event +///@file +/// Keyboard event // // Copyright (C) 2014 Thomas Geymayer // @@ -26,6 +27,9 @@ namespace simgear namespace canvas { + /** + * Keyboard (button up/down) event + */ class KeyboardEvent: public DeviceEvent { diff --git a/simgear/canvas/events/MouseEvent.hxx b/simgear/canvas/events/MouseEvent.hxx index d3223f59..df52d97d 100644 --- a/simgear/canvas/events/MouseEvent.hxx +++ b/simgear/canvas/events/MouseEvent.hxx @@ -1,4 +1,5 @@ -///@file Mouse event +///@file +/// Mouse event // // Copyright (C) 2012 Thomas Geymayer // @@ -26,6 +27,9 @@ namespace simgear namespace canvas { + /** + * Mouse (button/move/wheel) event + */ class MouseEvent: public DeviceEvent { diff --git a/simgear/canvas/layout/BoxLayout.hxx b/simgear/canvas/layout/BoxLayout.hxx index 1978439a..82d08a02 100644 --- a/simgear/canvas/layout/BoxLayout.hxx +++ b/simgear/canvas/layout/BoxLayout.hxx @@ -1,4 +1,4 @@ -// Align items horizontally or vertically in a box +/// @file // // Copyright (C) 2014 Thomas Geymayer // @@ -26,6 +26,11 @@ namespace simgear namespace canvas { + /** + * Align LayoutItems horizontally or vertically in a box. + * + * @see http://qt-project.org/doc/qt-4.8/qboxlayout.html#details + */ class BoxLayout: public Layout { diff --git a/simgear/canvas/layout/Layout.hxx b/simgear/canvas/layout/Layout.hxx index e543db25..673c990e 100644 --- a/simgear/canvas/layout/Layout.hxx +++ b/simgear/canvas/layout/Layout.hxx @@ -1,4 +1,4 @@ -// Basic class for canvas layouts +/// @file // // Copyright (C) 2014 Thomas Geymayer // @@ -27,6 +27,9 @@ namespace simgear namespace canvas { + /** + * Base class for all Canvas layouts. + */ class Layout: public LayoutItem { diff --git a/simgear/canvas/layout/LayoutItem.hxx b/simgear/canvas/layout/LayoutItem.hxx index 1adf2c67..79347cce 100644 --- a/simgear/canvas/layout/LayoutItem.hxx +++ b/simgear/canvas/layout/LayoutItem.hxx @@ -1,4 +1,5 @@ -///@file Basic element for layouting canvas elements +///@file +/// Basic element for layouting canvas elements. // // Copyright (C) 2014 Thomas Geymayer // diff --git a/simgear/canvas/layout/NasalWidget.hxx b/simgear/canvas/layout/NasalWidget.hxx index 504a41e7..02a26ba2 100644 --- a/simgear/canvas/layout/NasalWidget.hxx +++ b/simgear/canvas/layout/NasalWidget.hxx @@ -1,4 +1,5 @@ -///@file Glue for GUI widgets implemented in Nasal space +///@file +/// Glue for GUI widgets implemented in Nasal space. // // Copyright (C) 2014 Thomas Geymayer // @@ -31,7 +32,7 @@ namespace canvas { /** - * Baseclass/ghost to create widgets with Nasal. + * Base class/ghost to implement gui widgets in Nasal space. */ class NasalWidget: public LayoutItem, diff --git a/simgear/canvas/layout/SpacerItem.hxx b/simgear/canvas/layout/SpacerItem.hxx index b3b4f4e6..8e5346d8 100644 --- a/simgear/canvas/layout/SpacerItem.hxx +++ b/simgear/canvas/layout/SpacerItem.hxx @@ -1,4 +1,4 @@ -///@file Element providing blank space in a layout. +///@file // // Copyright (C) 2014 Thomas Geymayer // diff --git a/simgear/io/HTTPFileRequest.hxx b/simgear/io/HTTPFileRequest.hxx index 8adc9003..43d1cbd5 100644 --- a/simgear/io/HTTPFileRequest.hxx +++ b/simgear/io/HTTPFileRequest.hxx @@ -1,4 +1,4 @@ -///@file HTTP request writing response to a file. +///@file // // Copyright (C) 2013 Thomas Geymayer // @@ -27,6 +27,9 @@ namespace simgear namespace HTTP { + /** + * HTTP request writing response to a file. + */ class FileRequest: public Request { diff --git a/simgear/io/HTTPMemoryRequest.hxx b/simgear/io/HTTPMemoryRequest.hxx index bea45d0f..1c25ebc4 100644 --- a/simgear/io/HTTPMemoryRequest.hxx +++ b/simgear/io/HTTPMemoryRequest.hxx @@ -1,4 +1,4 @@ -///@file HTTP request keeping response in memory. +///@file // // Copyright (C) 2013 Thomas Geymayer // @@ -27,6 +27,9 @@ namespace simgear namespace HTTP { + /** + * HTTP request keeping response in memory. + */ class MemoryRequest: public Request { diff --git a/simgear/io/HTTPRequest.cxx b/simgear/io/HTTPRequest.cxx index 0809c70a..b9466ebf 100644 --- a/simgear/io/HTTPRequest.cxx +++ b/simgear/io/HTTPRequest.cxx @@ -1,3 +1,20 @@ +// Copyright (C) 2011 James Turner +// Copyright (C) 2013 Thomas Geymayer +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Library General Public +// License as published by the Free Software Foundation; either +// version 2 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Library General Public License for more details. +// +// You should have received a copy of the GNU Library General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + #include "HTTPRequest.hxx" #include diff --git a/simgear/io/HTTPRequest.hxx b/simgear/io/HTTPRequest.hxx index f739d2b8..2365b855 100644 --- a/simgear/io/HTTPRequest.hxx +++ b/simgear/io/HTTPRequest.hxx @@ -1,3 +1,22 @@ +///@file +// +// Copyright (C) 2011 James Turner +// Copyright (C) 2013 Thomas Geymayer +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Library General Public +// License as published by the Free Software Foundation; either +// version 2 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Library General Public License for more details. +// +// You should have received a copy of the GNU Library General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + #ifndef SG_HTTP_REQUEST_HXX #define SG_HTTP_REQUEST_HXX @@ -18,6 +37,9 @@ namespace simgear namespace HTTP { +/** + * Base class for HTTP request (and answer). + */ class Request: public SGReferenced { diff --git a/simgear/misc/SVGpreserveAspectRatio.hxx b/simgear/misc/SVGpreserveAspectRatio.hxx index 83cce89c..8930cca8 100644 --- a/simgear/misc/SVGpreserveAspectRatio.hxx +++ b/simgear/misc/SVGpreserveAspectRatio.hxx @@ -1,4 +1,5 @@ -///@file Parse and represent SVG preserveAspectRatio attribute +///@file +/// Parse and represent SVG preserveAspectRatio attribute. // // Copyright (C) 2014 Thomas Geymayer // @@ -53,6 +54,7 @@ namespace simgear bool operator==(const SVGpreserveAspectRatio& rhs) const; + /// Parse preserveAspectRatio from string. static SVGpreserveAspectRatio parse(const std::string& str); private: diff --git a/simgear/misc/SimpleMarkdown.hxx b/simgear/misc/SimpleMarkdown.hxx index ea98184a..db39b412 100644 --- a/simgear/misc/SimpleMarkdown.hxx +++ b/simgear/misc/SimpleMarkdown.hxx @@ -1,4 +1,5 @@ -///@file Really simple markdown parser +///@file +/// Really simple markdown parser. // // Copyright (C) 2014 Thomas Geymayer // diff --git a/simgear/nasal/cppbind/NasalContext.hxx b/simgear/nasal/cppbind/NasalContext.hxx index 00f84674..c5e8e56c 100644 --- a/simgear/nasal/cppbind/NasalContext.hxx +++ b/simgear/nasal/cppbind/NasalContext.hxx @@ -1,4 +1,4 @@ -///@file Manage lifetime and encapsulate a Nasal context +///@file // // Copyright (C) 2014 Thomas Geymayer // @@ -24,6 +24,9 @@ namespace nasal { + /** + * Manage lifetime and encapsulate a Nasal context. + */ class Context { public: diff --git a/simgear/nasal/cppbind/NasalHash.hxx b/simgear/nasal/cppbind/NasalHash.hxx index 641644c2..a5ce4769 100644 --- a/simgear/nasal/cppbind/NasalHash.hxx +++ b/simgear/nasal/cppbind/NasalHash.hxx @@ -1,4 +1,4 @@ -///@file Wrapper class for Nasal hashes +///@file // // Copyright (C) 2012 Thomas Geymayer // @@ -29,7 +29,7 @@ namespace nasal { /** - * A Nasal Hash + * Wrapper class for Nasal hashes. */ class Hash { diff --git a/simgear/nasal/cppbind/NasalObject.hxx b/simgear/nasal/cppbind/NasalObject.hxx index 4ee85029..05543254 100644 --- a/simgear/nasal/cppbind/NasalObject.hxx +++ b/simgear/nasal/cppbind/NasalObject.hxx @@ -1,4 +1,4 @@ -///@file Object exposed to Nasal including a Nasal hash for data storage. +///@file // // Copyright (C) 2014 Thomas Geymayer // @@ -28,6 +28,9 @@ namespace nasal { + /** + * Object exposed to Nasal including a Nasal hash for data storage. + */ class Object: public virtual SGVirtualWeakReferenced { diff --git a/simgear/nasal/cppbind/NasalObjectHolder.hxx b/simgear/nasal/cppbind/NasalObjectHolder.hxx index f2db7704..55fb5ba1 100644 --- a/simgear/nasal/cppbind/NasalObjectHolder.hxx +++ b/simgear/nasal/cppbind/NasalObjectHolder.hxx @@ -1,4 +1,5 @@ -///@file Wrapper class for keeping Nasal objects save from the garbage collector +///@file +/// Wrapper class for keeping Nasal objects save from the garbage collector. // // Copyright (C) 2013 Thomas Geymayer // diff --git a/simgear/nasal/cppbind/NasalString.hxx b/simgear/nasal/cppbind/NasalString.hxx index ad9e506f..e94dab7d 100644 --- a/simgear/nasal/cppbind/NasalString.hxx +++ b/simgear/nasal/cppbind/NasalString.hxx @@ -1,4 +1,4 @@ -///@file Wrapper class for Nasal strings +///@file // // Copyright (C) 2013 Thomas Geymayer // @@ -26,7 +26,7 @@ namespace nasal { /** - * A Nasal String + * Wrapper class for Nasal strings. */ class String { diff --git a/simgear/props/easing_functions.cxx b/simgear/props/easing_functions.cxx index 2548be71..5111ebaa 100644 --- a/simgear/props/easing_functions.cxx +++ b/simgear/props/easing_functions.cxx @@ -60,11 +60,22 @@ namespace simgear return 0.5 + 0.5 * (*easeOut)(t - 1); } + /** + * Helper for exponential ease out with integer exponent. + * + * @tparam N Exponent. + * @tparam is_odd If the exponent is odd. + */ template struct easeOutImpl; - /// http://easings.net/#easeOutCubic (N = 3) - /// http://easings.net/#easeOutQuint (N = 5) + /** + * Ease out with odd integer exponent. + * + * @tparam N Exponent. + * @see http://easings.net/#easeOutCubic (N = 3) + * @see http://easings.net/#easeOutQuint (N = 5) + */ template struct easeOutImpl { @@ -74,8 +85,13 @@ namespace simgear } }; - /// http://easings.net/#easeOutQuad (N = 2) - /// http://easings.net/#easeOutQuart (N = 4) + /** + * Ease out with even integer exponent. + * + * @tparam N Exponent. + * @see http://easings.net/#easeOutQuad (N = 2) + * @see http://easings.net/#easeOutQuart (N = 4) + */ template struct easeOutImpl { @@ -85,10 +101,15 @@ namespace simgear } }; - /// http://easings.net/#easeOutQuad (N = 2) - /// http://easings.net/#easeOutCubic (N = 3) - /// http://easings.net/#easeOutQuart (N = 4) - /// http://easings.net/#easeOutQuint (N = 5) + /** + * Exponential ease out with integer exponent. + * + * @see http://easings.net/#easeOutQuad (N = 2) + * @see http://easings.net/#easeOutCubic (N = 3) + * @see http://easings.net/#easeOutQuart (N = 4) + * @see http://easings.net/#easeOutQuint (N = 5) + * @see easeOutImpl + */ template double easeOutPow(double t) { diff --git a/simgear/structure/function_list.hxx b/simgear/structure/function_list.hxx index 28ef08e4..314c16ed 100644 --- a/simgear/structure/function_list.hxx +++ b/simgear/structure/function_list.hxx @@ -1,4 +1,4 @@ -///@file Handle a list of callbacks like a single boost::function +///@file // // Copyright (C) 2014 Thomas Geymayer // @@ -39,6 +39,11 @@ namespace simgear # define BOOST_PP_FILENAME_1 # include BOOST_PP_ITERATE() + /** + * Handle a list of callbacks like a single boost::function. + * + * @tparam Sig Function signature. + */ template class function_list >: public function_list diff --git a/simgear/structure/map.hxx b/simgear/structure/map.hxx index 20c5afca..695013fb 100644 --- a/simgear/structure/map.hxx +++ b/simgear/structure/map.hxx @@ -1,4 +1,4 @@ -///@file Extended std::map with methods for easier usage. +///@file // // Copyright (C) 2013 Thomas Geymayer // @@ -25,6 +25,9 @@ namespace simgear { + /** + * Extended std::map with methods for easier usage. + */ template class Map: public std::map -- 2.39.5