BeBits Information Developer Central Submit Application Your Account Web Links Contact Us
BeBits
ImprovedDocumentation
Documentation is made of many parts. The first obvious piece of documentation that most developers for BeOS have become familiar with is the BeBook. Aside from that, there is also the common method of looking at the supplied headers. When looking at code itself, documentation is generally considered to be comments. However, another important part of code documentation is names.

In header files these names figure most prominently in three places. First, the class names. Second, the method names. Third, the argument names.

Of these, only the last can be changed without affecting past code. Of course, this doesn't mean that we shouldn't change or supplement the others if it doesn't serve a good purpose. (this is the principle of GE after all)

One type of error which we can help to avert by changing the argument names are DeallocationRightsErrors.

shatty!


PAGE VISITS
1,271

LINKS HERE
GeneralArchitecture

NEW PAGES
CrosscompilingFirefox
BuildingCairo
StoringDataInBetweenOSes
ScriptingBeosRuby
ScriptingBeosPython
HaikuOS
QemUwinbe
MinimalBeos
XpMBRoverwrite
SteveSakoman

RECENT CHANGES
BuildingFirebird
FrontPage
BeAcademic
CrosscompilingFirefox
HowTo
BuildingCairo
BeCommunity
PlayGround
CorumIII
SupportForMachinesAndArchitectures
Edit Page | Front Page | BeBits
Site content is in the public domain. Unless otherwise noted, everything else is copyright © 1999-2009 BeBits. All Rights Reserved.
For more legal trivia, take a gander at our
Legal Stuff page and our Privacy Statement.