| |
| |
On Am 11/19/21 1:19 PM schrieb imacarthur wrote:
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
*/
Thanks. Done in commit 4d31c5bd4f3a45.
<OT>
Hint: If you or anybody else want to send a patch with a commit message
and your own author you can do the following:
1) make sure your repo is up-to-date (`git checkout master; git pull`)
2) check out a working branch (`git checkout -b working`)
3) change code and commit your changes
4) create patch file(s): `git format-patch master..`
Note the trailing '..' !
This will create one or more patch files with names like
'nnnn-Commit-Message-Title.patch where 'nnnn' is a sequence number. Then
attach the patch file(s) to the message.
To clean up your repo:
5) git checkout master
6) git branch -D working
Note the uppercase 'D' to delete the unmerged branch.
Such patch files can be applied with `git am 000*.patch` in sequence and
with the original time stamp and author.
Of course this is not necessary, I can also apply the patch as it was
pasted in the message text. This hint is just in case someone wants to
send in a patch and keep their author and commit messages.
I put this on my todo list for the appropriate article.
</OT>
--
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/875733da-c191-8dd3-b5f2-0a68c1e2287a%40online.de.
[ Direct Link to Message ] | |
|
| |
