Opened 8 years ago

Closed 8 years ago

#7994 closed enhancement (fixed)

Update BScreen class style and variable names, remove documentation from Screen.cpp file, create Screen.dox documentation file

Reported by: jscipione Owned by: nielx
Priority: normal Milestone: R1
Component: Documentation Version: R1/Development
Keywords: Cc:
Blocked By: Blocking:
Has a Patch: yes Platform: All

Description

This ticket updates the BScreen class renaming some variables to make them consistent with the header or related methods, adding some spaces and other style changes. Preceding underscores were removed from variable names in some cases. The documentation is removed from the Screen.cpp file and is added to the dox file instead. NO FUNCTIONAL CHANGES are intended. These changes to the BScreen class are to aid in the second part, adding BScreen to the Haiku book.

The second part of this ticket is a dox file for the BScreen class to be added to the docs/user/interface directory in order to add the class documentation to the Haiku Book. The documentation is not simply a copy of the documentation in the Screen.cpp file but has been updated significantly. I added the names of the people from the Screen.cpp file (Stefano Ceccherini and Axel Dörfler) to the Authors section Screen.dox file as well as myself.

Attachments (4)

BScreen_style_update_and_variable_renaming_1.diff (15.7 KB ) - added by jscipione 8 years ago.
Patch to remove the documentation from the Screen.cpp file and rename some variables and other style updates. NO FUNCTIONAL CHANGE intended.
BScreen_style_update_and_variable_renaming_2.diff (15.3 KB ) - added by jscipione 8 years ago.
Upon further reading of the style used in the source I found that the underscores in the parameters for GetBitmap() and GetModeList() were okay so I didn't remove them. The underscores in the params for GetMode() are not and they should be there for GetPixelClockLimits(). Still no functional changes intended.
Screen.dox (16.6 KB ) - added by jscipione 8 years ago.
BScreen class documentation taking into account proper underscore method style.
BScreen_style_update_and_variable_renaming_3.diff (15.4 KB ) - added by jscipione 8 years ago.
SetDesktopColor() should have a parameter named stick, not makeDefault

Download all attachments as: .zip

Change History (9)

by jscipione, 8 years ago

Patch to remove the documentation from the Screen.cpp file and rename some variables and other style updates. NO FUNCTIONAL CHANGE intended.

comment:1 by jscipione, 8 years ago

Has a Patch: set

comment:2 by jscipione, 8 years ago

Has a Patch: unset

by jscipione, 8 years ago

Upon further reading of the style used in the source I found that the underscores in the parameters for GetBitmap() and GetModeList() were okay so I didn't remove them. The underscores in the params for GetMode() are not and they should be there for GetPixelClockLimits(). Still no functional changes intended.

comment:3 by jscipione, 8 years ago

Has a Patch: set

by jscipione, 8 years ago

Attachment: Screen.dox added

BScreen class documentation taking into account proper underscore method style.

by jscipione, 8 years ago

SetDesktopColor() should have a parameter named stick, not makeDefault

comment:4 by nielx, 8 years ago

Status: newin-progress

I am reviewing the doc!

comment:5 by nielx, 8 years ago

Resolution: fixed
Status: in-progressclosed

Fixed in hrev42984.

Note: See TracTickets for help on using tickets.