Fix #1783: repeated error message on console

[simgear.git] / simgear / canvas / CanvasObjectPlacement.hxx

diff --git a/simgear/canvas/CanvasObjectPlacement.hxx b/simgear/canvas/CanvasObjectPlacement.hxx
index 40c0550ac8be9c6d6e0900525821f9a2b10be93f..a97aeb6e095dd41b537b2cf7ab66eb2777e96e0b 100644 (file)
--- a/simgear/canvas/CanvasObjectPlacement.hxx
+++ b/simgear/canvas/CanvasObjectPlacement.hxx
@@ -1,7 +1,8 @@
-// Canvas placement for placing a canvas texture onto osg 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 <tomgey@gmail.com>
 //
@@ -19,7 +20,7 @@
 // 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 CANVAS_PICK_PLACEMENT_HXX_
+#ifndef CANVAS_OBJECT_PLACEMENT_HXX_
 #define CANVAS_OBJECT_PLACEMENT_HXX_
 
 #include "CanvasPlacement.hxx"
@@ -33,6 +34,9 @@ namespace simgear
 namespace canvas
 {
 
+  /**
+   * Place a Canvas onto an osg object (as texture).
+   */
   class ObjectPlacement:
     public Placement
   {
@@ -72,4 +76,4 @@ namespace canvas
 } // namespace canvas
 } // namespace simgear
 
-#endif /* CANVAS_PICK_PLACEMENT_HXX_ */
+#endif /* CANVAS_OBJECT_PLACEMENT_HXX_ */