FLTK logo

[fltk.coredev] fltk-1.4 doxygen warning for new fl_draw_check

FLTK matrix user chat room
(using Element browser app)   FLTK gitter user chat room   GitHub FLTK Project   FLTK News RSS Feed  
  FLTK Apps      FLTK Library      Forums      Links     Login 
 All Forums  |  Back to fltk.coredev  ]
 
Previous Message ]New Message | Reply ]Next Message ]

fltk-1.4 doxygen warning for new fl_draw_check imacarthur Nov 19, 2021  
  Doxygen throws the following (at least for me!) when building the 1.4 branch...

=== making documentation ===
Generating HTML documentation...
D:/Support/fltk-1.4/src/fl_draw.cxx:481: warning: argument 'X' of command @param is not found in the argument list of fl_draw_check(Fl_Rect bb, Fl_Color col)
D:/Support/fltk-1.4/src/fl_draw.cxx:481: warning: argument 'Y' of command @param is not found in the argument list of fl_draw_check(Fl_Rect bb, Fl_Color col)
D:/Support/fltk-1.4/src/fl_draw.cxx:481: warning: argument 'W' of command @param is not found in the argument list of fl_draw_check(Fl_Rect bb, Fl_Color col)
D:/Support/fltk-1.4/src/fl_draw.cxx:481: warning: argument 'H' of command @param is not found in the argument list of fl_draw_check(Fl_Rect bb, Fl_Color col)
D:/Support/fltk-1.4/FL/fl_draw.H:930: warning: The following parameters of fl_draw_check(Fl_Rect bb, Fl_Color col) are not documented:
  parameter 'bb'
  parameter 'col'
/d/Support


It just looks like the doxygen comment has fallen out of sync with the code a bit. I suggest the following patch would probably do the job:

--------------
diff --git a/src/fl_draw.cxx b/src/fl_draw.cxx
index 26f49f10f..247492f17 100644
--- a/src/fl_draw.cxx
+++ b/src/fl_draw.cxx
@@ -492,8 +492,8 @@ void fl_restore_scale(float s) {

   The size limits are implementation details and may be changed at any time.

-  \param[in]  X,Y  top left corner of the bounding box
-  \param[in]  W,H  width and height of the bounding box
+  \param[in]  bb  rectangle that defines the bounding box
+  \param[in]  col Fl_Color to draw the check mark

   \since 1.4.0
 */


--
You received this message because you are subscribed to the Google Groups "fltk.coredev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to fltkcoredev+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/fltkcoredev/6cdb9ca3-46c7-47a1-a73b-6ce7c0172f82n%40googlegroups.com.
Direct Link to Message ]
 
     
Previous Message ]New Message | Reply ]Next Message ]
 
 

Comments are owned by the poster. All other content is copyright 1998-2024 by Bill Spitzak and others. This project is hosted by The FLTK Team. Please report site problems to 'erco@seriss.com'.