Improve comments, patch provided by Vladimir Prus!
authorChris Lattner <sabre@nondot.org>
Mon, 15 May 2006 17:25:05 +0000 (17:25 +0000)
committerChris Lattner <sabre@nondot.org>
Mon, 15 May 2006 17:25:05 +0000 (17:25 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@28305 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/Target/TargetMachineRegistry.h

index 55cc9581777a3ab4220d98853f3711ffaeab126b..dd3ed7da96621262b349594bb887a8e11b7169f9 100644 (file)
@@ -70,7 +70,13 @@ namespace llvm {
   /// RegisterTarget - This class is used to make targets automatically register
   /// themselves with the tool they are linked.  Targets should define an
   /// instance of this and implement the static methods described in the
-  /// TargetMachine comments..
+  /// TargetMachine comments.
+  /// The type 'TargetMachineImpl' should provide a constructor with two 
+  /// parameters:
+  /// - const Module& M: the module that is being compiled:
+  /// - const std::string& FS: target-specific string describing target 
+  ///   flavour.
+  
   template<class TargetMachineImpl>
   struct RegisterTarget : public TargetMachineRegistry::Entry {
     RegisterTarget(const char *Name, const char *ShortDesc) :