Bug 334326 - API documentation for DisplayTwo::turn(int cardNumber) has a flaw
Summary: API documentation for DisplayTwo::turn(int cardNumber) has a flaw
Status: RESOLVED FIXED
Alias: None
Product: lskat
Classification: Applications
Component: general (show other bugs)
Version: unspecified
Platform: unspecified Unspecified
: NOR minor
Target Milestone: ---
Assignee: martin
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-05-04 12:56 UTC by Martin Walch
Modified: 2014-07-31 10:53 UTC (History)
1 user (show)

See Also:
Latest Commit: commits.kde.org/lskat/349959b88dcbaf7f5cf0d6629ff8ca3dfe441cd0
Version Fixed In: 4.14.0
Sentry Crash Report:

Attachments
fix API doc, typos in code comments and clean up whitespace (11.67 KB, patch)
2014-05-04 12:58 UTC, Martin Walch 		Details
same patch as above, but with additional typo fixed (11.67 KB, patch)
2014-05-04 13:25 UTC, Martin Walch 		Details
Show Obsolete (1) View All Add an attachment

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Walch 2014-05-04 12:56:39 UTC 
src/display_two.h says for DisplayTwo::turn(int cardNumber):

* @param cardNumber The card number (0-7)

This should probably read

* @param cardNumber The card number (0-31)

Also, there are some typos like "Recive" and "esxisting".

Reproducible: Always
Comment 1 Martin Walch 2014-05-04 12:58:46 UTC 
Created attachment 86451 [details]
fix API doc, typos in code comments and clean up whitespace

Fix the documentation flaw, some typos and clean up whitespace when touching the files anyway.
Comment 2 Martin Walch 2014-05-04 13:25:14 UTC 
Created attachment 86452 [details]
same patch as above, but with additional typo fixed

numner -> number
Comment 3 Martin Walch 2014-07-23 23:19:44 UTC 
I just added the patch to the review board:

https://git.reviewboard.kde.org/r/119431/
Comment 4 Martin Walch 2014-07-31 10:53:38 UTC 
Submitted by Albert Astals Cid (Thank you)

http://commits.kde.org/lskat/349959b88dcbaf7f5cf0d6629ff8ca3dfe441cd0