diff options
author | Campbell Barton <ideasman42@gmail.com> | 2012-03-02 20:05:54 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2012-03-02 20:05:54 +0400 |
commit | 7bbf4b78313df9f6d2c760b527eb36a5d0418b82 (patch) | |
tree | ace55a086362cf5b35174d55442322a793dd32c1 /source/blender/editors/include | |
parent | c8636ca3dd8bde1cc548ef21fb7a1fd304799164 (diff) |
style cleanup
- spelling - turns out we had tessellation spelt wrong all over.
- use \directive for doxy (not @directive)
- remove BLI_sparsemap.h - was from bmesh merge IIRC but entire file commented and not used.
Diffstat (limited to 'source/blender/editors/include')
-rw-r--r-- | source/blender/editors/include/BIF_glutil.h | 54 | ||||
-rw-r--r-- | source/blender/editors/include/ED_anim_api.h | 2 | ||||
-rw-r--r-- | source/blender/editors/include/ED_view3d.h | 80 |
3 files changed, 68 insertions, 68 deletions
diff --git a/source/blender/editors/include/BIF_glutil.h b/source/blender/editors/include/BIF_glutil.h index b5dbf906d84..77c50f9ca6d 100644 --- a/source/blender/editors/include/BIF_glutil.h +++ b/source/blender/editors/include/BIF_glutil.h @@ -55,27 +55,27 @@ extern unsigned char stipple_diag_stripes_neg[128]; /** * Draw a lined (non-looping) arc with the given - * @a radius, starting at angle @a start and arcing - * through @a angle. The arc is centered at the origin + * \a radius, starting at angle \a start and arcing + * through \a angle. The arc is centered at the origin * and drawn in the XY plane. * - * @param start The initial angle (in radians). - * @param angle The length of the arc (in radians). - * @param radius The arc radius. - * @param nsegments The number of segments to use in drawing the arc. + * \param start The initial angle (in radians). + * \param angle The length of the arc (in radians). + * \param radius The arc radius. + * \param nsegments The number of segments to use in drawing the arc. */ void glutil_draw_lined_arc (float start, float angle, float radius, int nsegments); /** - * Draw a filled arc with the given @a radius, - * starting at angle @a start and arcing through - * @a angle. The arc is centered at the origin + * Draw a filled arc with the given \a radius, + * starting at angle \a start and arcing through + * \a angle. The arc is centered at the origin * and drawn in the XY plane. * - * @param start The initial angle (in radians). - * @param angle The length of the arc (in radians). - * @param radius The arc radius. - * @param nsegments The number of segments to use in drawing the arc. + * \param start The initial angle (in radians). + * \param angle The length of the arc (in radians). + * \param radius The arc radius. + * \param nsegments The number of segments to use in drawing the arc. */ void glutil_draw_filled_arc (float start, float angle, float radius, int nsegments); @@ -93,11 +93,11 @@ float glaGetOneFloat (int param); /** * Functions like glRasterPos2i, except ensures that the resulting - * raster position is valid. @a known_good_x and @a known_good_y + * raster position is valid. \a known_good_x and \a known_good_y * should be coordinates of a point known to be within the current * view frustum. - * @attention This routine should be used when the distance of @a x - * and @a y away from the known good point is small (ie. for small icons + * \attention This routine should be used when the distance of \a x + * and \a y away from the known good point is small (ie. for small icons * and for bitmap characters), when drawing large+zoomed images it is * possible for overflow to occur, the glaDrawPixelsSafe routine should * be used instead. @@ -106,20 +106,20 @@ void glaRasterPosSafe2f (float x, float y, float known_good_x, float known_good /** * Functions like a limited glDrawPixels, except ensures that - * the image is displayed onscreen even if the @a x and @a y + * the image is displayed onscreen even if the \a x and \a y * coordinates for would be clipped. The routine respects the * glPixelZoom values, pixel unpacking parameters are _not_ * respected. - * @attention This routine makes many assumptions: the rect data + * \attention This routine makes many assumptions: the rect data * is expected to be in RGBA unsigned byte format, the coordinate * (0.375, 0.375) is assumed to be within the view frustum, and the * modelview and projection matrices are assumed to define a * 1-to-1 mapping to screen space. - * @attention Furthmore, in the case of zoomed or unpixel aligned + * \attention Furthmore, in the case of zoomed or unpixel aligned * images extending outside the view frustum, but still within the * window, some portion of the image may be visible left and/or - * below of the given @a x and @a y coordinates. It is recommended + * below of the given \a x and \a y coordinates. It is recommended * to use the glScissor functionality if images are to be drawn * with an inset view matrix. */ @@ -132,7 +132,7 @@ void glaDrawPixelsSafe (float x, float y, int img_w, int img_h, int row_w, int * clipped when offscreen. The routine respects the glPixelZoom values, * pixel unpacking parameters are _not_ respected. - * @attention This routine makes many assumptions: the rect data + * \attention This routine makes many assumptions: the rect data * is expected to be in RGBA byte or float format, and the * modelview and projection matrices are assumed to define a * 1-to-1 mapping to screen space. @@ -152,7 +152,7 @@ void glaDrawPixelsTexScaled(float x, float y, int img_w, int img_h, int format, * thus no reason to +-0.5 the coordinates or perform other silly * tricks. * - * @param screen_rect The screen rectangle to be defined for 2D drawing. + * \param screen_rect The screen rectangle to be defined for 2D drawing. */ void glaDefine2DArea (struct rcti *screen_rect); @@ -170,17 +170,17 @@ typedef struct gla2DDrawInfo gla2DDrawInfo; * thus no reason to +-0.5 the coordinates or perform other silly * tricks. * - * @param screen_rect The screen rectangle to be used for 2D drawing. - * @param world_rect The world rectangle that the 2D area represented - * by @a screen_rect is supposed to represent. If NULL it is assumed the + * \param screen_rect The screen rectangle to be used for 2D drawing. + * \param world_rect The world rectangle that the 2D area represented + * by \a screen_rect is supposed to represent. If NULL it is assumed the * world has a 1 to 1 mapping to the screen. */ gla2DDrawInfo* glaBegin2DDraw (struct rcti *screen_rect, struct rctf *world_rect); - /** Translate the (@a wo_x, @a wo_y) point from world coordinates into screen space. */ + /** Translate the (\a wo_x, \a wo_y) point from world coordinates into screen space. */ void gla2DDrawTranslatePt (gla2DDrawInfo *di, float wo_x, float wo_y, int *sc_x_r, int *sc_y_r); - /** Translate the @a world point from world coordiantes into screen space. */ + /** Translate the \a world point from world coordiantes into screen space. */ void gla2DDrawTranslatePtv (gla2DDrawInfo *di, float world[2], int screen_r[2]); /* Restores the previous OpenGL state and free's the auxilary diff --git a/source/blender/editors/include/ED_anim_api.h b/source/blender/editors/include/ED_anim_api.h index 2b00f854bb1..a9affbcd342 100644 --- a/source/blender/editors/include/ED_anim_api.h +++ b/source/blender/editors/include/ED_anim_api.h @@ -427,7 +427,7 @@ void ANIM_channel_setting_set(bAnimContext *ac, bAnimListElem *ale, int setting, * - anim_data: list of the all the anim channels that can be chosen * -> filtered using ANIMFILTER_CHANNELS only, since if we took VISIBLE too, * then the channels under closed expanders get ignored... - * - ale_setting: the anim channel (not in the anim_data list directly, though occuring there) + * - ale_setting: the anim channel (not in the anim_data list directly, though occurring there) * with the new state of the setting that we want flushed up/down the hierarchy * - setting: type of setting to set * - on: whether the visibility setting has been enabled or disabled diff --git a/source/blender/editors/include/ED_view3d.h b/source/blender/editors/include/ED_view3d.h index 4c68b53d5cd..23321e0e48f 100644 --- a/source/blender/editors/include/ED_view3d.h +++ b/source/blender/editors/include/ED_view3d.h @@ -91,10 +91,10 @@ int initgrabz(struct RegionView3D *rv3d, float x, float y, float z); /** * Calculate a 3d location from 2d window coordinates. - * @param ar The region (used for the window width and height). - * @param depth_pt The reference location used to calculate the Z depth. - * @param mval The area relative location (such as event->mval converted to floats). - * @param out The resulting world-space location. + * \param ar The region (used for the window width and height). + * \param depth_pt The reference location used to calculate the Z depth. + * \param mval The area relative location (such as event->mval converted to floats). + * \param out The resulting world-space location. */ void ED_view3d_win_to_3d(struct ARegion *ar, const float depth_pt[3], const float mval[2], float out[3]); @@ -102,9 +102,9 @@ void ED_view3d_win_to_3d(struct ARegion *ar, const float depth_pt[3], const floa * Calculate a 3d difference vector from 2d window offset. * note that initgrabz() must be called first to determine * the depth used to calculate the delta. - * @param ar The region (used for the window width and height). - * @param mval The area relative 2d difference (such as event->mval[0] - other_x). - * @param out The resulting world-space delta. + * \param ar The region (used for the window width and height). + * \param mval The area relative 2d difference (such as event->mval[0] - other_x). + * \param out The resulting world-space delta. */ void ED_view3d_win_to_delta(struct ARegion *ar, const float mval[2], float out[3]); @@ -112,9 +112,9 @@ void ED_view3d_win_to_delta(struct ARegion *ar, const float mval[2], float out[3 * Calculate a 3d direction vector from 2d window coordinates. * This direction vector starts and the view in the direction of the 2d window coordinates. * In orthographic view all window coordinates yield the same vector. - * @param ar The region (used for the window width and height). - * @param mval The area relative 2d location (such as event->mval converted to floats). - * @param out The resulting normalized world-space direction vector. + * \param ar The region (used for the window width and height). + * \param mval The area relative 2d location (such as event->mval converted to floats). + * \param out The resulting normalized world-space direction vector. */ void ED_view3d_win_to_vector(struct ARegion *ar, const float mval[2], float out[3]); @@ -124,11 +124,11 @@ void ED_view3d_win_to_vector(struct ARegion *ar, const float mval[2], float out[ * ray_start and ray_end are clipped by the view near and far limits * so points along this line are always in view. * In orthographic view all resulting segments will be parallel. - * @param ar The region (used for the window width and height). - * @param v3d The 3d viewport (used for near and far clipping range). - * @param mval The area relative 2d location (such as event->mval, converted into float[2]). - * @param ray_start The world-space starting point of the segment. - * @param ray_end The world-space end point of the segment. + * \param ar The region (used for the window width and height). + * \param v3d The 3d viewport (used for near and far clipping range). + * \param mval The area relative 2d location (such as event->mval, converted into float[2]). + * \param ray_start The world-space starting point of the segment. + * \param ray_end The world-space end point of the segment. */ void ED_view3d_win_to_segment_clip(struct ARegion *ar, struct View3D *v3d, const float mval[2], float ray_start[3], float ray_end[3]); @@ -137,58 +137,58 @@ void ED_view3d_win_to_segment_clip(struct ARegion *ar, struct View3D *v3d, const * This ray_start is located at the viewpoint, ray_normal is the direction towards mval. * ray_start is clipped by the view near limit so points in front of it are always in view. * In orthographic view the resulting ray_normal will match the view vector. - * @param ar The region (used for the window width and height). - * @param v3d The 3d viewport (used for near clipping value). - * @param mval The area relative 2d location (such as event->mval, converted into float[2]). - * @param ray_start The world-space starting point of the segment. - * @param ray_normal The normalized world-space direction of towards mval. + * \param ar The region (used for the window width and height). + * \param v3d The 3d viewport (used for near clipping value). + * \param mval The area relative 2d location (such as event->mval, converted into float[2]). + * \param ray_start The world-space starting point of the segment. + * \param ray_normal The normalized world-space direction of towards mval. */ void ED_view3d_win_to_ray(struct ARegion *ar, struct View3D *v3d, const float mval[2], float ray_start[3], float ray_normal[3]); /** * Calculate a normalized 3d direction vector from the viewpoint towards a global location. * In orthographic view the resulting vector will match the view vector. - * @param rv3d The region (used for the window width and height). - * @param coord The world-space location. - * @param vec The resulting normalized vector. + * \param rv3d The region (used for the window width and height). + * \param coord The world-space location. + * \param vec The resulting normalized vector. */ void ED_view3d_global_to_vector(struct RegionView3D *rv3d, const float coord[3], float vec[3]); /** * Calculate the view transformation matrix from RegionView3D input. * The resulting matrix is equivalent to RegionView3D.viewinv - * @param mat The view 4x4 transformation matrix to calculate. - * @param ofs The view offset, normally from RegionView3D.ofs. - * @param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * @param dist The view distance from ofs, normally from RegionView3D.dist. + * \param mat The view 4x4 transformation matrix to calculate. + * \param ofs The view offset, normally from RegionView3D.ofs. + * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_to_m4(float mat[][4], const float ofs[3], const float quat[4], const float dist); /** * Set the view transformation from a 4x4 matrix. - * @param mat The view 4x4 transformation matrix to assign. - * @param ofs The view offset, normally from RegionView3D.ofs. - * @param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * @param dist The view distance from ofs, normally from RegionView3D.dist. + * \param mat The view 4x4 transformation matrix to assign. + * \param ofs The view offset, normally from RegionView3D.ofs. + * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_from_m4(float mat[][4], float ofs[3], float quat[4], float *dist); /** * Set the RegionView3D members from an objects transformation and optionally lens. - * @param ob The object to set the view to. - * @param ofs The view offset to be set, normally from RegionView3D.ofs. - * @param quat The view rotation to be set, quaternion normally from RegionView3D.viewquat. - * @param dist The view distance from ofs to be set, normally from RegionView3D.dist. - * @param lens The view lens angle set for cameras and lamps, normally from View3D.lens. + * \param ob The object to set the view to. + * \param ofs The view offset to be set, normally from RegionView3D.ofs. + * \param quat The view rotation to be set, quaternion normally from RegionView3D.viewquat. + * \param dist The view distance from ofs to be set, normally from RegionView3D.dist. + * \param lens The view lens angle set for cameras and lamps, normally from View3D.lens. */ void ED_view3d_from_object(struct Object *ob, float ofs[3], float quat[4], float *dist, float *lens); /** * Set the object transformation from RegionView3D members. - * @param ob The object which has the transformation assigned. - * @param ofs The view offset, normally from RegionView3D.ofs. - * @param quat The view rotation, quaternion normally from RegionView3D.viewquat. - * @param dist The view distance from ofs, normally from RegionView3D.dist. + * \param ob The object which has the transformation assigned. + * \param ofs The view offset, normally from RegionView3D.ofs. + * \param quat The view rotation, quaternion normally from RegionView3D.viewquat. + * \param dist The view distance from ofs, normally from RegionView3D.dist. */ void ED_view3d_to_object(struct Object *ob, const float ofs[3], const float quat[4], const float dist); |