Cleanup pass on documentation that was dumping garbage into doxygen output.

(bzr r10696)

6 files changed, 56 insertions, 54 deletions

diff --git a/src/extension/internal/gimpgrad.h b/src/extension/internal/gimpgrad.h
index 5ab48a147..c34de840d 100644
--- a/src/extension/internal/gimpgrad.h
+++ b/src/extension/internal/gimpgrad.h
@@ -1,7 +1,4 @@
-/** \file
- *
- * Implementation class of the GIMP gradient plugin.
- *
+/*
  * Authors:
  *   Ted Gould <ted@gould.cx>
  *
@@ -9,7 +6,7 @@
  *
  * Released under GNU GPL, read the file 'COPYING' for more information
  */
-
+// TODO add include guard
 #include <glibmm/ustring.h>
 
 #include "extension/implementation/implementation.h"
@@ -21,10 +18,12 @@ class Extension;
 
 namespace Internal {
 
-/** \brief  Implementation class of the GIMP gradient plugin.  This mostly
-            just creates a namespace for the GIMP gradient plugin today.
-*/
-class GimpGrad : public Inkscape::Extension::Implementation::Implementation {
+/**
+ * Implementation class of the GIMP gradient plugin.
+ * This mostly just creates a namespace for the GIMP gradient plugin today.
+ */
+class GimpGrad : public Inkscape::Extension::Implementation::Implementation
+{
 public:
     bool load(Inkscape::Extension::Extension *module);
     void unload(Inkscape::Extension::Extension *module);
@@ -34,7 +33,9 @@ public:
 };
 
 
-} } }  /* namespace Internal; Extension; Inkscape */
+} // namespace Internal
+} // namespace Extension
+} // namespace Inkscape
 
 /*
   Local Variables:
diff --git a/src/extension/internal/odf.h b/src/extension/internal/odf.h
index 2a6f7799f..a4a13681a 100644
--- a/src/extension/internal/odf.h
+++ b/src/extension/internal/odf.h
@@ -1,14 +1,4 @@
-/**
- * OpenDocument <drawing> input and output
- *
- * This is an an entry in the extensions mechanism to begin to enable
- * the inputting and outputting of OpenDocument Format (ODF) files from
- * within Inkscape.  Although the initial implementations will be very lossy
- * do to the differences in the models of SVG and ODF, they will hopefully
- * improve greatly with time.
- *
- * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html
- *
+/*
  * Authors:
  *   Bob Jamison
  *   Abhishek Sharma
@@ -265,6 +255,17 @@ public:
 
 
 
+/**
+ * OpenDocument <drawing> input and output
+ *
+ * This is an an entry in the extensions mechanism to begin to enable
+ * the inputting and outputting of OpenDocument Format (ODF) files from
+ * within Inkscape.  Although the initial implementations will be very lossy
+ * do to the differences in the models of SVG and ODF, they will hopefully
+ * improve greatly with time.
+ *
+ * http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/idl-definitions.html
+ */
 class OdfOutput : public Inkscape::Extension::Implementation::Implementation
 {
 
diff --git a/src/extension/internal/pdfinput/pdf-input.h b/src/extension/internal/pdfinput/pdf-input.h
index c2fd0b6d8..6d3fd104a 100644
--- a/src/extension/internal/pdfinput/pdf-input.h
+++ b/src/extension/internal/pdfinput/pdf-input.h
@@ -1,9 +1,7 @@
-#ifndef __EXTENSION_INTERNAL_PDFINPUT_H__
-#define __EXTENSION_INTERNAL_PDFINPUT_H__
+#ifndef SEEN_EXTENSION_INTERNAL_PDFINPUT_H
+#define SEEN_EXTENSION_INTERNAL_PDFINPUT_H
 
- /** \file
- * PDF import using libpoppler.
- *
+/*
  * Authors:
  *   miklos erdelyi
  *
@@ -50,6 +48,9 @@ namespace Widget {
 namespace Extension {
 namespace Internal {
 
+/**
+ * PDF import using libpoppler.
+ */
 class PdfImportDialog : public Gtk::Dialog
 {
 public:
@@ -125,11 +126,13 @@ public:
 
 };
 
-} } }  /* namespace Inkscape, Extension, Implementation */
+} // namespace Implementation
+} // namespace Extension
+} // namespace Inkscape
 
-#endif /* HAVE_POPPLER */
+#endif // HAVE_POPPLER
 
-#endif /* __EXTENSION_INTERNAL_PDFINPUT_H__ */
+#endif // SEEN_EXTENSION_INTERNAL_PDFINPUT_H
 
 /*
   Local Variables:
diff --git a/src/extension/internal/pdfinput/pdf-parser.h b/src/extension/internal/pdfinput/pdf-parser.h
index 21effe81d..a63d669c7 100644
--- a/src/extension/internal/pdfinput/pdf-parser.h
+++ b/src/extension/internal/pdfinput/pdf-parser.h
@@ -1,7 +1,4 @@
-
- /** \file
- * PDF parsing module using libpoppler's facilities
- *
+ /*
  * Derived from Gfx.h
  *
  * Copyright 1996-2003 Glyph & Cog, LLC
@@ -24,6 +21,8 @@ namespace Inkscape {
         }
     }
 }
+
+// TODO clean up and remove using:
 using Inkscape::Extension::Internal::SvgBuilder;
 
 #include "goo/gtypes.h"
@@ -145,6 +144,10 @@ private:
 #define pdfNumShadingTypes 5
 
 
+
+/**
+ * PDF parsing module using libpoppler's facilities.
+ */
 class PdfParser {
 public:
 
diff --git a/src/extension/internal/pdfinput/svg-builder.h b/src/extension/internal/pdfinput/svg-builder.h
index 47e5d7735..7a36be806 100644
--- a/src/extension/internal/pdfinput/svg-builder.h
+++ b/src/extension/internal/pdfinput/svg-builder.h
@@ -1,9 +1,7 @@
-#ifndef __EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H__
-#define __EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H__
+#ifndef SEEN_EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H
+#define SEEN_EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H
 
- /** \file
- * SVG representation creator using libpoppler.
- *
+/*
  * Authors:
  *   miklos erdelyi
  *
@@ -58,8 +56,7 @@ namespace Internal {
 struct SvgTransparencyGroup;
 
 /**
- * \struct SvgGraphicsState
- * Holds information about the current softmask and group depth.
+ * Holds information about the current softmask and group depth for use of libpoppler.
  * Could be later used to store other graphics state parameters so that we could
  * emit only the differences in style settings from the parent state.
  */
@@ -69,7 +66,6 @@ struct SvgGraphicsState {
 };
 
 /**
- * \struct SvgGlyph
  * Holds information about glyphs added by PdfParser which haven't been added
  * to the document yet.
  */
@@ -89,10 +85,7 @@ struct SvgGlyph {
 };
 
 /**
- * \class SvgBuilder
- *
- * Builds the inner SVG representation from the calls of PdfParser
- *
+ * Builds the inner SVG representation using libpoppler from the calls of PdfParser.
  */
 class SvgBuilder {
 public:
@@ -232,11 +225,13 @@ private:
 };
 
 
-} } } /* namespace Inkscape, Extension, Internal */
+} // namespace Internal
+} // namespace Extension
+} // namespace Inkscape
 
-#endif /* HAVE_POPPLER */
+#endif // HAVE_POPPLER
 
-#endif /* __EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H__ */
+#endif // SEEN_EXTENSION_INTERNAL_PDFINPUT_SVGBUILDER_H
 
 /*
   Local Variables:
diff --git a/src/extension/script/InkscapeScript.h b/src/extension/script/InkscapeScript.h
index c4a59e1e2..2ebeb1b19 100644
--- a/src/extension/script/InkscapeScript.h
+++ b/src/extension/script/InkscapeScript.h
@@ -1,9 +1,7 @@
-#ifndef __INKSCAPE_SCRIPT_H__
-#define __INKSCAPE_SCRIPT_H__
+#ifndef SEEN_INKSCAPE_SCRIPT_H
+#define SEEN_INKSCAPE_SCRIPT_H
 
-/**
- * Inkscape Scripting container
- *
+/*
  * Authors:
  *   Bob Jamison <rjamison@titan.com>
  *
@@ -26,7 +24,8 @@ namespace Script
 
 
 /**
- * This class is used to run scripts, either from a file or buffer
+ * Inkscape Scripting container.
+ * This class is used to run scripts, either from a file or buffer.
  */
 class InkscapeScript
 {