Changes between Version 32 and Version 33 of MapGuideCodingStandards

Timestamp:

Dec 8, 2012, 6:24:26 AM (11 years ago)

Author:

jng

Comment:

doxygen examples

MapGuideCodingStandards

@@ -86 +86 @@
  1. Cause the method in question to appear under the list of deprecated methods (and appear as deprecated under the class method documentation) in the API documentation that's generated by doxygen
  2. Allow for us in the future to convert these directives to {{{[ObsoleteAttribute]}}} in .net and {{{@Deprecated}}} in Java for their proxy classes.
+
+An example:
+{{{
+   ///////////////////////////////////////////////////////
+   /// \brief
+   /// Don't use me
+   ///
+   /// \deprecated
+   void AMethodThatShouldNotBeUsedAnymore();
+}}}
+
+For new APIs, indicate the milestone the API was introduced with the {{{\since}}} directive
+
+For example if the new API is available since 2.5:
+{{{
+
+   ///////////////////////////////////////////////////////
+   /// \brief
+   /// Some new method
+   ///
+   /// \since 2.5
+   void SomeNewMethod();
+}}}
 
 === General ===