[Cmake-commits] [cmake-commits] alex committed cmReturnCommand.h 1.2 1.3

[cmake-commits at cmake.org]

Update of /cvsroot/CMake/CMake/Source
In directory public:/mounts/ram/cvs-serv22097/Source

Modified Files:
	cmReturnCommand.h 
Log Message:
STYLE: extend documentation for RETURN() a bit
ENH: add a test for calling RETURN() in an included file

Alex


Index: cmReturnCommand.h
===================================================================
RCS file: /cvsroot/CMake/CMake/Source/cmReturnCommand.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C 2 -d -r1.2 -r1.3
*** cmReturnCommand.h	23 Jan 2008 23:34:19 -0000	1.2
--- cmReturnCommand.h	16 Aug 2008 22:06:17 -0000	1.3
***************
*** 58,62 ****
    virtual const char* GetTerseDocumentation() 
      {
!     return "Return from a directory or function.";
      }
    
--- 58,62 ----
    virtual const char* GetTerseDocumentation() 
      {
!     return "Return from a file, directory or function.";
      }
    
***************
*** 68,75 ****
      return
        "  return()\n"
!       "Returns from a directory or function. When this command is "
!       "encountered, it caused process of the current function or "
!       "directory to stop and control is return to the caller of the "
!       "function, or the parent directory if any. Note that a macro "
        "is not a function and does not handle return like a function does.";
      }
--- 68,79 ----
      return
        "  return()\n"
!       "Returns from a file, directory or function. When this command is "
!       "encountered in an included file (via include() or find_package()), "
!       "it causes processing of the current file to stop and control is "
!       "returned to the including file. If it is encountered in a file which "
!       "is not included by another file, e.g. a CMakeLists.txt, control is "
!       "returned to the parent directory if there is one. "
!       "If return is called in a function, control is returned to the caller "
!       "of the function. Note that a macro "
        "is not a function and does not handle return like a function does.";
      }