Skip to content
This repository was archived by the owner on Jan 7, 2023. It is now read-only.

Commit a6f9b06

Browse files
committed
fastuidraw: doxytag fixes
1 parent 13028af commit a6f9b06

6 files changed

Lines changed: 19 additions & 18 deletions

File tree

inc/fastuidraw/gl_backend/painter_backend_gl.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ namespace fastuidraw
500500
* the texture (with GL) and the texture must not be
501501
* deleted (or have its backing store changed via
502502
* glTexImage) until the SurfaceGL is deleted.
503-
* \param dimes width and height of the GL texture
503+
* \param dims width and height of the GL texture
504504
* \param gl_texture GL name of texture
505505
*/
506506
explicit

inc/fastuidraw/painter/packing/painter_packer.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ namespace fastuidraw
268268
/*!
269269
* Sets the active composite shader.
270270
* \param h composite shader to use for compositing.
271-
* \param packed_composite_mode 3D API blend mode.
271+
* \param blend_mode 3D API blend mode.
272272
*/
273273
void
274274
composite_shader(const reference_counted_ptr<PainterCompositeShader> &h,

inc/fastuidraw/painter/painter.hpp

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ namespace fastuidraw
132132
/*!
133133
* Sets the composite shader.
134134
* \param h composite shader to use for compositing.
135-
* \param packed_composite_mode 3D API blend mode
135+
* \param blend_mode 3D API blend mode
136136
*/
137137
void
138138
composite_shader(const reference_counted_ptr<PainterCompositeShader> &h,
@@ -572,7 +572,7 @@ namespace fastuidraw
572572
* Calls FilledPath::select_subsets() passing arguments derived from the
573573
* current state of the Painter.
574574
* \param path \ref FilledPath from which to compute subset selection
575-
* \param[out] dst location to which to write the \ref Subset ID values
575+
* \param[out] dst location to which to write the FilledPath::Subset ID values
576576
* \returns the number of Subset object ID's written to dst, that
577577
* number is guaranteed to be no more than FilledPath::number_subsets().
578578
*/
@@ -588,7 +588,7 @@ namespace fastuidraw
588588
* \param item_space_additional_room amount additional slack in -local coordinate-
589589
* in selecting subsets from the StrokedPath
590590
* geometry data
591-
* \param[out] dst location to which to write the \ref Subset ID values
591+
* \param[out] dst location to which to write the StrokedPath::Subset ID values
592592
* \returns the number of Subset object ID's written to dst, that
593593
* number is guaranteed to be no more than StrokedPath::number_subsets().
594594
*/
@@ -608,8 +608,8 @@ namespace fastuidraw
608608
* in selecting subsets from the StrokedPath
609609
* geometry data
610610
* \param include_closing_edges if true, include the joins of the closing edges
611-
* \param select_joins_for_miter_style if true join selection reflects those joins
612-
* that would be visible if drawn as miter-joins.
611+
* \param take_all_joins if true, filtering of joins is not performed, i.e. all
612+
* joins of the \ref StrokedCapsJoins are selected
613613
* \param[out] dst location to which to write what chunks
614614
*/
615615
void
@@ -625,8 +625,8 @@ namespace fastuidraw
625625
* \param shader shader with which to stroke the attribute data
626626
* \param draw data for how to draw
627627
* \param path StrokedPath to stroke
628-
* \param rounded_thresh value to feed to \ref StrokedPath::rounded_joins()
629-
* and/or \ref StrokedPath::rounded_caps() if rounded
628+
* \param rounded_thresh value to feed to StrokedCapsJoins::rounded_joins()
629+
* and/or StrokedCapsJoins::rounded_caps() if rounded
630630
* joins and/or rounded caps are requested
631631
* \param stroke_style how to stroke the path
632632
* \param anti_alias_quality specifies the shader based anti-alias
@@ -674,8 +674,8 @@ namespace fastuidraw
674674
* \param shader shader with which to draw
675675
* \param draw data for how to draw
676676
* \param path StrokedPath to stroke
677-
* \param rounded_thresh value to feed to \ref StrokedPath::rounded_joins()
678-
* and/or \ref StrokedPath::rounded_caps() if rounded
677+
* \param rounded_thresh value to feed to StrokedCapsJoins::rounded_joins()
678+
* and/or StrokedCapsJoins::rounded_caps() if rounded
679679
* joins and/or rounded caps are requested
680680
* \param stroke_style how to stroke the path
681681
* \param anti_alias_quality specifies the shader based anti-alias

inc/fastuidraw/painter/painter_dashed_stroke_params.hpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,9 @@ namespace fastuidraw
186186

187187
/*!
188188
* Returns a StrokingDataSelectorBase suitable for PainterDashedStrokeParams.
189-
* \param pixel_arc_stroking_possible if true, will inform that arc-stroking
190-
* width in \ref pixel_stroking_units is
191-
* possible.
189+
* \param pixel_arc_stroking_possible if true, will inform that arc-stroking width
190+
* in PainterStrokeParams::pixel_stroking_units
191+
* is possible.
192192
*/
193193
static
194194
reference_counted_ptr<const StrokingDataSelectorBase>

inc/fastuidraw/painter/painter_fill_shader.hpp

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,9 @@ namespace fastuidraw
105105
hq_anti_alias_support(enum PainterEnums::hq_anti_alias_support_t sh);
106106

107107
/*!
108-
* Used by \ref Painter for the \ref shader_anti_alias_t value
109-
* to use when \ref shader_anti_alias_fastest is requested.
108+
* Used by \ref Painter for the PainterEnums:shader_anti_alias_t
109+
* value to use when PainterEnums::shader_anti_alias_fastest is
110+
* requested.
110111
*/
111112
enum PainterEnums::shader_anti_alias_t
112113
fastest_anti_alias_mode(void) const;

inc/fastuidraw/painter/painter_stroke_shader.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -238,8 +238,8 @@ namespace fastuidraw
238238
hq_anti_alias_support(enum PainterEnums::hq_anti_alias_support_t sh);
239239

240240
/*!
241-
* Used by \ref Painter for the \ref shader_anti_alias_t value
242-
* to use when \ref shader_anti_alias_fastest is requested.
241+
* Used by \ref Painter for the PainterEnums::shader_anti_alias_t value
242+
* to use when PainterEnums::shader_anti_alias_fastest is requested.
243243
* \param tp specify to return non-aa shader for arc or linear stroking
244244
*/
245245
enum PainterEnums::shader_anti_alias_t

0 commit comments

Comments
 (0)