Author: cargilld
Date: Thu Aug 11 07:12:41 2005
New Revision: 231465
URL: http://svn.apache.org/viewcvs?rev=231465&view=rev
Log:
Update coding convertions for naming of enums.
Modified:
xerces/c/branches/xerces-2.7/doc/faq-contributing.xml
Modified: xerces/c/branches/xerces-2.7/doc/faq-contributing.xml
URL:
http://svn.apache.org/viewcvs/xerces/c/branches/xerces-2.7/doc/faq-contributing.xml?rev=231465&r1=231464&r2=231465&view=diff
==============================================================================
--- xerces/c/branches/xerces-2.7/doc/faq-contributing.xml (original)
+++ xerces/c/branches/xerces-2.7/doc/faq-contributing.xml Thu Aug 11 07:12:41
2005
@@ -163,6 +163,13 @@
the source file StringPool.cpp.</li>
<li>In general, code should be documented with comments. Use JavaDoc
tags to describe methods.</li>
+
+ <li>The naming convention for ENUMS should be choosen to be unique and
descriptive
+ (i.e. INVALID or UNKNOWN) to avoid colliding with predefined macros in
other
+ products. The current style of using ALL CAP enums should be phased out
with
+ Mixed Case instead, except for names specified in standards (for
example, TEXT_NODE
+ should not be converted to mixed case for standards compliance).</li>
+
</ol>
</a>
</faq>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
