gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-05-30 16:30:41 +00:00
Code Issues Projects Releases Packages Wiki Activity

* Documentation/coding-standards.texi: Add section of documentation.

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@20640 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
fedor 2005-01-31 18:35:32 +00:00
parent eadacf7ce5
commit e1b944688b
2 changed files with 23 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
ChangeLog
View file

@ -1,3 +1,7 @@
2005-01-31 Adam Fedor <fedor@gnu.org>
* Documentation/coding-standards.texi: Add section of documentation.
2005-01-29 03:46 Matt Rice <ratmice@yahoo.com> 2005-01-29 03:46 Matt Rice <ratmice@yahoo.com>
* Source/NSUndoManager.m (-registerUndoWithTarget:selector:object:): * Source/NSUndoManager.m (-registerUndoWithTarget:selector:object:):

21
Documentation/coding-standards.texi
View file

@ -62,6 +62,7 @@ into another language, under the above conditions for modified versions.
* Error Handling:: * Error Handling::
* Variable Declaration:: * Variable Declaration::
* Object Persistance:: * Object Persistance::
* Documentation::
* Before You Commit:: * Before You Commit::
* Contributing:: * Contributing::
@end menu @end menu
@ -349,7 +350,7 @@ commonly used compilers.
@c ****************************************************************** @c ******************************************************************
@node Object Persistance, Before You Commit, Variable Declaration, Top @node Object Persistance, Documentation, Variable Declaration, Top
@section Object Persistance @section Object Persistance
The standard method of saving and restoring object information in GNUstep The standard method of saving and restoring object information in GNUstep
@ -362,7 +363,22 @@ this is to use class version numbers to indicate which archive configuration
should be read. should be read.
@c ****************************************************************** @c ******************************************************************
@node Before You Commit, Contributing, Object Persistance, Top @node Documentation, Before You Commit, Object Persistance, Top
@section Documentation
Document every method you change or add! This makes it easier to fix our
lack of documentation and keep up to date with changes. Make sure you
do not copy either the OpenStep or Cocoa documentation. Some methods
are so simple you might have to intentionally reword the documentation
so it is different.
Currently there is a differance of opinion on whether to document in
the header or in the source file, although we generally lean towards
the header currently. Make sure you are consistant with the current
method of documentation in the source file you are changing.
@c ******************************************************************
@node Before You Commit, Contributing, Documentation, Top
@section Before You Commit @section Before You Commit
@itemize @bullet @itemize @bullet
@ -371,6 +387,7 @@ should be read.
@item Make sure you've tested the change as much as is reasonable. @item Make sure you've tested the change as much as is reasonable.
@item If you have added a class, add the class to @file{Foudation/Foundation.h} @item If you have added a class, add the class to @file{Foudation/Foundation.h}
or @file{Appkit/Appkit.h} if appropriate. or @file{Appkit/Appkit.h} if appropriate.
@item Documentation the methods you have changed or added.
@item If you have updated and configure checks, be sure to run both @item If you have updated and configure checks, be sure to run both
autoconf and autoheader. autoconf and autoheader.
@end itemize @end itemize