Commit bd423ae6 authored by Hans Breuer's avatar Hans Breuer

dox: [warningectomy] missing parameter documentation ...

 - add plug-ins/pdf for documentation extraction
 - remove second occurrence of plug-ins/svg
 - fix doxygen complaints about missing parameter documentation
 - fix a bug in export-render.py where the parameter was documented,
   used in the implementation but not declared
 - fix title mismatch for group ObjectConnects
parent 3cf17cc8
......@@ -11,9 +11,9 @@ TYPEDEF_HIDES_STRUCT = NO
WARN_IF_UNDOCUMENTED = NO
WARN_LOGFILE = doxygen.log
INPUT = ../lib ../objects/standard ../objects/custom \
../plug-ins/python ../plug-ins/svg ../plug-ins/shape \
../plug-ins/cairo ../plug-ins/layout ../plug-ins/svg \
../plug-ins/wpg
../plug-ins/python ../plug-ins/svg ../plug-ins/shape \
../plug-ins/cairo ../plug-ins/layout ../plug-ins/pdf \
../plug-ins/wpg
#STRIP_FROM_PATH = ../
FILE_PATTERNS = *.c *.h *.dox *.py *.cpp
# define HAVE_CAIRO to get the Outline dox
......
......@@ -849,6 +849,7 @@ bezierconn_destroy (BezierConn *bezier)
/** Save the data defined by a bezierconn object to XML.
* @param bezier The object to save.
* @param obj_node The XML node to save it into
* @param ctx The context to transport error information.
*/
void
bezierconn_save (BezierConn *bezier,
......
......@@ -928,6 +928,7 @@ beziershape_destroy (BezierShape *bezier)
/** Save the data defined by a beziershape object to XML.
* @param bezier The object to save.
* @param obj_node The XML node to save it into
* @param ctx The context to transport error information.
*/
void
beziershape_save (BezierShape *bezier,
......
......@@ -84,7 +84,7 @@ and "connected by" (connectionpoint->connected). The former is a 0 or 1 relation
*/
/*!
\defgroup ObjectConnects Connecting Objects
\defgroup ObjectConnects Object Connections
\ingroup Objects
\brief Implementation details of connections between \ref _DiaObject "objects"
......
......@@ -740,7 +740,7 @@ dia_svg_parse_style_string (DiaSvgStyle *s, real user_scale, const gchar *str)
* @param node An XML node to parse a style from.
* @param s The SVG style object to fill out. This should previously be
* initialized to some default values.
* @param user_scale, if >0 scalable values (font-size, stroke-width, ...)
* @param user_scale if >0 scalable values (font-size, stroke-width, ...)
* are divided by this, otherwise ignored
*
* \ingroup DiaSvg
......
......@@ -290,6 +290,7 @@ xmlDiaParseFile(const char *filename, DiaContext *ctx)
/*!
* \brief Parse an xml file from a filename given in Dia's/GLib's filename encoding
* @param filename A file to parse. On win32 the filename encoding is utf-8 since GLib 2.6
* @param error Optional error return form underlying library.
* @return An XML document.
* \ingroup DiagramXmlIo
*/
......@@ -1055,6 +1056,7 @@ composite_add_attribute(DataNode composite_node,
* \brief Add integer data to an attribute node.
* @param attr The attribute node.
* @param data The value to set.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1073,6 +1075,7 @@ data_add_int(AttributeNode attr, int data, DiaContext *ctx)
* \brief Add enum data to an attribute node.
* @param attr The attribute node.
* @param data The value to set.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1091,6 +1094,7 @@ data_add_enum(AttributeNode attr, int data, DiaContext *ctx)
* \brief Add real-typed data to an attribute node.
* @param attr The attribute node.
* @param data The value to set.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1109,6 +1113,7 @@ data_add_real(AttributeNode attr, real data, DiaContext *ctx)
* \brief Add boolean data to an attribute node.
* @param attr The attribute node.
* @param data The value to set.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1153,6 +1158,7 @@ convert_to_hex(float x, char *str)
* \brief Add color data to an attribute node.
* @param attr The attribute node.
* @param col The value to set.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1190,6 +1196,7 @@ _str_point (const Point *point)
* \brief Add point data to an attribute node.
* @param attr The attribute node.
* @param point The value to set.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1245,6 +1252,7 @@ data_add_bezpoint(AttributeNode attr, const BezPoint *point, DiaContext *ctx)
* \brief Add rectangle data to an attribute node.
* @param attr The attribute node.
* @param rect The value to set.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1274,6 +1282,7 @@ data_add_rectangle(AttributeNode attr, const Rectangle *rect, DiaContext *ctx)
* \brief Add string data to an attribute node.
* @param attr The attribute node.
* @param str The value to set.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1303,6 +1312,7 @@ data_add_string(AttributeNode attr, const char *str, DiaContext *ctx)
* @param data The data node.
* @param str The filename value to set. This should be n the local filesystem
* encoding, not utf-8.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1319,6 +1329,7 @@ data_add_filename(DataNode data, const char *str, DiaContext *ctx)
* \brief Add font data to an attribute node.
* @param attr The attribute node.
* @param font The value to set.
* @param ctx The context to transport error information.
* \ingroup DiagramXmlOut
*/
void
......@@ -1340,6 +1351,7 @@ data_add_font(AttributeNode attr, const DiaFont *font, DiaContext *ctx)
* \brief Add a new composite node to an attribute node.
* @param attr The attribute node to add to.
* @param type The type of the new node.
* @param ctx The context to transport error information.
* @return The new child of `attr'.
* \ingroup DiagramXmlOut
*/
......
......@@ -780,6 +780,7 @@ object_unconnect_all(DiaObject *obj)
* basic data (currently position and bounding box).
* @param obj An object to save.
* @param obj_node An XML node to save the data to.
* @param ctx The context to transport error information.
*/
void
object_save(DiaObject *obj, ObjectNode obj_node, DiaContext *ctx)
......@@ -1019,7 +1020,7 @@ object_load_using_properties(const DiaObjectType *type,
* for an object with normal attributes.
* @param obj The object to save.
* @param obj_node The XML structure to save into.
* @param filename The name of the file being saved to, for error messages.
* @param ctx The context to transport error information.
*/
void
object_save_using_properties(DiaObject *obj, ObjectNode obj_node,
......
......@@ -68,7 +68,7 @@ class DumpRenderer :
# @param points An array of points in the diagram coordinate system
# @param fill The color to use for the interior
# @param stroke The color to use for the line
def draw_polygon (self, points, fill) :
def draw_polygon (self, points, fill, stroke) :
self.f.write("draw_polygon: " + str(fill) + str(stroke) + "\n")
for pt in points :
self.f.write ("\t" + str(pt) + "\n")
......
......@@ -212,7 +212,7 @@ _node_get_real (xmlNodePtr node, const char *name, real defval)
/*!
* \brief Translate an existing object to a new position
* <use/> has x and y attributes, use to position
* The tag 'use' has x and y attributes to position the used object
* \ingroup SvgImport
*/
static void
......@@ -1387,9 +1387,10 @@ read_gradient (xmlNodePtr node, DiaSvgStyle *parent_gs, GHashTable *pattern_ht,
/*!
* \brief Parse the CSS style block of the SVG
*
* Extract style information from the given node into a map for later use.
*
* @node : containing the style
* @ht: hash table with style key and style string
* @param node containing the style
* @param ht hash table with style key and style string
*
* \ingroup SvgImport
*/
......@@ -1455,7 +1456,7 @@ add_def (gpointer data,
* This function is modifying the global user scale. If it's effect
* should be temporary user_scale needs to be saved before.
*
* @param node element containing the viewBox attribute
* @param root element containing the viewBox attribute
* @param mat out parameter for optional matrix transform
*
* \ingroup SvgImport
......@@ -1535,6 +1536,8 @@ _node_read_viewbox (xmlNodePtr root, DiaMatrix **mat)
* @param startnode the XML node to dive into
* @param parent_gs the graphic style inherited by parent
* @param defs_ht a map of objects filled from 'defs' to use as templates for 'use'
* @param style_ht map of styles
* @param pattern_ht map of patterns
* @param filename_svg SVG filename for better error messages
* @param ctx context to keep error messages grouped
* @return a list of _DiaObject
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment