head	1.2;
access;
symbols;
locks; strict;
comment	@# @;


1.2
date	2007.04.01.14.51.53;	author TimSutton;	state Exp;
branches;
next	1.1;

1.1
date	2007.03.31.19.38.36;	author TimSutton;	state Exp;
branches;
next	;


desc
@none
@


1.2
log
@none
@
text
@%META:TOPICINFO{author="TimSutton" date="1175439113" format="1.1" reprev="1.2" version="1.2"}%
%META:TOPICPARENT{name="GeoAppInter"}%
---+++ Basics

<verbatim>

/** @@defgroup Foo    // or @@ingroup Foo  
  * This is a foo class  */
class FooBar {

   private var $fooVar;
   private var $barVar;
   
   /** This is a foo function.
    * @@returns a bar object.
    */
   function FooBar ( $_fooVar, $_barVar ) {
      $var = "foo";
   }
}
</verbatim>

This would be saved to a file based on the class name FooBar.php

---+++ Documenting

We are using [[http://www.stack.nl/~dimitri/doxygen/][doxygen]] to document all code. We require only the class description and 'ingroup' tags as mandatory, other in class docs are optional. If you refer to another class in the /**  */ comments doxygen will hyperlink so make sure to spell correctly.

---+++ Paging

To avoid dealing with  paging we will limit all search results to 500

---+++ Naming

   * Name class names with CamelCase, leading capital letter.
   * Name class files with ClassName.php
   * Name functions with fooFunction (camel case, leading lower case letter)
 
-- Main.TimSutton - 31 Mar 2007
@


1.1
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TimSutton" date="1175369916" format="1.1" reprev="1.1" version="1.1"}%
d7 2
a8 1
/**  This is a foo class  */
d25 4
d33 6
@