Commit 2e3f017c authored by claes's avatar claes

Doxygen modifications

parent 809428e4
/* /*
* Proview $Id: rt_gdh.c,v 1.19 2005-10-07 05:57:28 claes Exp $ * Proview $Id: rt_gdh.c,v 1.20 2005-10-12 12:59:35 claes Exp $
* Copyright (C) 2005 SSAB Oxelsund AB. * Copyright (C) 2005 SSAB Oxelsund AB.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
...@@ -125,8 +125,8 @@ pwr_tStatus ...@@ -125,8 +125,8 @@ pwr_tStatus
gdh_AttrrefToName ( gdh_AttrrefToName (
pwr_sAttrRef *arp, /**< Supplies the attribute reference structure pwr_sAttrRef *arp, /**< Supplies the attribute reference structure
that defines an attribute. */ that defines an attribute. */
char *name, /**< Receives the name of the form <object name>, char *name, /**< Receives the name of the form 'object name',
<attributename>. */ 'attributename'. */
unsigned int size, /**< Supplies the maximun length of the buffer */ unsigned int size, /**< Supplies the maximun length of the buffer */
pwr_tBitMask nametype /**< ZZZ */ pwr_tBitMask nametype /**< ZZZ */
) )
......
/* /*
* Proview $Id: ge_graph.h,v 1.15 2005-10-07 05:57:28 claes Exp $ * Proview $Id: ge_graph.h,v 1.16 2005-10-12 12:57:28 claes Exp $
* Copyright (C) 2005 SSAB Oxelsund AB. * Copyright (C) 2005 SSAB Oxelsund AB.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
...@@ -264,7 +264,7 @@ class GraphApplList { ...@@ -264,7 +264,7 @@ class GraphApplList {
//! Constructor //! Constructor
/*! /*!
\param root The root of the list. \param appl_key Application key.
\param appl_ctx Application object. \param appl_ctx Application object.
*/ */
GraphApplList( void *appl_key, void *appl_ctx) : GraphApplList( void *appl_key, void *appl_ctx) :
...@@ -276,8 +276,8 @@ class GraphApplList { ...@@ -276,8 +276,8 @@ class GraphApplList {
GraphApplList *next; //!< Next element in list. GraphApplList *next; //!< Next element in list.
//! Insert an application in list. //! Insert an application in list.
/*! \param key Key for application. */ /*! \param key Key for application.
/*! \param ctx Application object to insert. */ \param ctx Application object to insert. */
void insert( void *key, void *ctx); void insert( void *key, void *ctx);
//! Remove an application from list. //! Remove an application from list.
...@@ -910,6 +910,7 @@ class Graph { ...@@ -910,6 +910,7 @@ class Graph {
\param inverted The attribute is inverted. \param inverted The attribute is inverted.
\param type Type of attribute. \param type Type of attribute.
\param size Size of attribute. \param size Size of attribute.
\param elem Array element.
The attribute reference is of type !VKV-P1-Str1.ActualValue##String80 which The attribute reference is of type !VKV-P1-Str1.ActualValue##String80 which
is inverted (!), of type pwr_eType_String with size 80. is inverted (!), of type pwr_eType_String with size 80.
......
/* /*
* Proview $Id: glow_growapi.h,v 1.14 2005-09-01 14:57:53 claes Exp $ * Proview $Id: glow_growapi.h,v 1.15 2005-10-12 12:59:05 claes Exp $
* Copyright (C) 2005 SSAB Oxelsund AB. * Copyright (C) 2005 SSAB Oxelsund AB.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
...@@ -987,6 +987,8 @@ typedef GlowTraceData glow_sTraceData; ...@@ -987,6 +987,8 @@ typedef GlowTraceData glow_sTraceData;
\param height Height of the rectangle. \param height Height of the rectangle.
\param draw_type Border color. \param draw_type Border color.
\param line_width Line width of border. \param line_width Line width of border.
\param fill Table filled.
\param fillcolor Fill color.
\param display_level Display levels when the object is visible. \param display_level Display levels when the object is visible.
\param user_data User data. \param user_data User data.
\param bar Created GrowWindow object. \param bar Created GrowWindow object.
...@@ -1645,7 +1647,7 @@ typedef GlowTraceData glow_sTraceData; ...@@ -1645,7 +1647,7 @@ typedef GlowTraceData glow_sTraceData;
//! Set object visibility. //! Set object visibility.
/*! /*!
\param object Object. \param object Object.
\param visible 1 object is visible, 0 object is invisible. \param visibility 1 object is visible, 0 object is invisible.
*/ */
void grow_SetObjectVisibility( grow_tObject object, glow_eVis visibility); void grow_SetObjectVisibility( grow_tObject object, glow_eVis visibility);
......
/* /*
* Proview $Id: glow_growctx.h,v 1.5 2005-09-01 14:57:53 claes Exp $ * Proview $Id: glow_growctx.h,v 1.6 2005-10-12 12:59:05 claes Exp $
* Copyright (C) 2005 SSAB Oxelsund AB. * Copyright (C) 2005 SSAB Oxelsund AB.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
...@@ -615,7 +615,6 @@ class GrowCtx : public GlowCtx { ...@@ -615,7 +615,6 @@ class GrowCtx : public GlowCtx {
//! Send a table callback if such a callback is registred. //! Send a table callback if such a callback is registred.
/*! /*!
\param object Menu object. \param object Menu object.
\param item Activated menu item.
\param event Menu event. \param event Menu event.
\param x x coordinate. \param x x coordinate.
\param y y coordinate. \param y y coordinate.
......
/* /*
* Proview $Id: glow_growfolder.h,v 1.3 2005-09-01 14:57:53 claes Exp $ * Proview $Id: glow_growfolder.h,v 1.4 2005-10-12 12:59:05 claes Exp $
* Copyright (C) 2005 SSAB Oxelsund AB. * Copyright (C) 2005 SSAB Oxelsund AB.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
...@@ -49,6 +49,8 @@ class GrowFolder : public GrowWindow { ...@@ -49,6 +49,8 @@ class GrowFolder : public GrowWindow {
\param h Height. \param h Height.
\param border_d_type Border color. \param border_d_type Border color.
\param line_w Linewidth of border. \param line_w Linewidth of border.
\param sel_color Color for selected tab.
\param unsel_color Color for unselected tab.
\param display_lev Displaylevel when this object is visible. \param display_lev Displaylevel when this object is visible.
\param nodraw Don't draw the object now. \param nodraw Don't draw the object now.
*/ */
......
/* /*
* Proview $Id: glow_grownode.h,v 1.8 2005-09-01 14:57:54 claes Exp $ * Proview $Id: glow_grownode.h,v 1.9 2005-10-12 12:59:05 claes Exp $
* Copyright (C) 2005 SSAB Oxelösund AB. * Copyright (C) 2005 SSAB Oxelösund AB.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
...@@ -512,7 +512,7 @@ class GrowNode : public GlowNode { ...@@ -512,7 +512,7 @@ class GrowNode : public GlowNode {
//! Set object visibility. //! Set object visibility.
/*! /*!
\param visible The visibility of the object. \param visibility The visibility of the object.
*/ */
void set_visibility( glow_eVis visibility); void set_visibility( glow_eVis visibility);
...@@ -920,6 +920,7 @@ class GrowNode : public GlowNode { ...@@ -920,6 +920,7 @@ class GrowNode : public GlowNode {
\param t_drawtype Annotation text drawtype. \param t_drawtype Annotation text drawtype.
\param t_color Annotation text color. \param t_color Annotation text color.
\param bg_color Annotation background color. \param bg_color Annotation background color.
\param scale Annotation scale.
\return 0 if annotation doesn't exist, else 1. \return 0 if annotation doesn't exist, else 1.
*/ */
int get_annotation_info( int num, int *t_size, glow_eDrawType *t_drawtype, glow_eDrawType *t_color, int get_annotation_info( int num, int *t_size, glow_eDrawType *t_drawtype, glow_eDrawType *t_color,
......
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