[cfe-commits] r158509 - /cfe/trunk/include/clang/Driver/Types.h

James Dennett jdennett at google.com
Fri Jun 15 01:49:07 PDT 2012


Author: jdennett
Date: Fri Jun 15 03:49:07 2012
New Revision: 158509

URL: http://llvm.org/viewvc/llvm-project?rev=158509&view=rev
Log:
Documentation cleanup: use \p ParameterName when referring to a parameter,
not \arg ParameterName (which should be used only when documenting that
parameter, not when referring to it from elsewhere).

Modified:
    cfe/trunk/include/clang/Driver/Types.h

Modified: cfe/trunk/include/clang/Driver/Types.h
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/include/clang/Driver/Types.h?rev=158509&r1=158508&r2=158509&view=diff
==============================================================================
--- cfe/trunk/include/clang/Driver/Types.h (original)
+++ cfe/trunk/include/clang/Driver/Types.h Fri Jun 15 03:49:07 2012
@@ -23,7 +23,7 @@
     TY_LAST
   };
 
-  /// getTypeName - Return the name of the type for \arg Id.
+  /// getTypeName - Return the name of the type for \p Id.
   const char *getTypeName(ID Id);
 
   /// getPreprocessedType - Get the ID of the type for this input when
@@ -70,7 +70,7 @@
   bool isObjC(ID Id);
 
   /// lookupTypeForExtension - Lookup the type to use for the file
-  /// extension \arg Ext.
+  /// extension \p Ext.
   ID lookupTypeForExtension(const char *Ext);
 
   /// lookupTypeForTypSpecifier - Lookup the type to use for a user
@@ -81,7 +81,7 @@
   /// to be done for this type.
   unsigned getNumCompilationPhases(ID Id);
 
-  /// getCompilationPhase - Return the \args N th compilation phase to
+  /// getCompilationPhase - Return the \p N th compilation phase to
   /// be done for this type.
   phases::ID getCompilationPhase(ID Id, unsigned N);
   





More information about the cfe-commits mailing list