Revision: 1505
http://svn.sourceforge.net/spring-rich-c/?rev=1505&view=rev
Author: ge0ffrey
Date: 2006-10-11 03:16:10 -0700 (Wed, 11 Oct 2006)
Log Message:
-----------
javadoc conventions
Modified Paths:
--------------
trunk/spring-richclient/src/site/apt/development/conventions.apt
Added Paths:
-----------
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/package-info.java
Modified: trunk/spring-richclient/src/site/apt/development/conventions.apt
===================================================================
--- trunk/spring-richclient/src/site/apt/development/conventions.apt
2006-10-11 09:54:10 UTC (rev 1504)
+++ trunk/spring-richclient/src/site/apt/development/conventions.apt
2006-10-11 10:16:10 UTC (rev 1505)
@@ -18,6 +18,9 @@
TODO: none yet, this has to be thoroughly discussed on the developer list:
Sun code conventions or eclipse build-in? With or without 120 chars per
line?
+ * Do not use subversion variables such as <<<$Revision$>>>,
+ if you need that information, use you IDE.
+
Naming Conventions
* Main code
@@ -46,8 +49,14 @@
* Javadocs
- TODO
+ * Package javadocs should be added in <<<package-info.java>>> files, not
in <<<package.html>>> files.
+ * Try to consistenly use the following javadoc tags:
+
+ * <<<@author Julius Caesar>>> <(to have an idea who knows that code
best)>
+
+ * <<<@since 0.3>>> <(for a pom version of "0.3.0-SNAPSHOT")>
+
* Site documentation
* All apt/fml/xdoc files should be in camelCase starting with a low letter.
Added:
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/package-info.java
===================================================================
---
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/package-info.java
(rev 0)
+++
trunk/spring-richclient/support/src/main/java/org/springframework/richclient/exceptionhandling/package-info.java
2006-10-11 10:16:10 UTC (rev 1505)
@@ -0,0 +1,4 @@
+/**
+ * Provides exception handlers to deal with uncaught exceptions.
+ */
+package org.springframework.richclient.exceptionhandling;
\ No newline at end of file
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
spring-rich-c-cvs mailing list
spring-rich-c-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/spring-rich-c-cvs
