Changeset 661

Show
Ignore:
Timestamp:
05/03/08 02:35:39 (14 months ago)
Author:
hobu
Message:

do'h. need c-style comments

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/include/liblas/capi/liblas.h

    r660 r661  
    109109/****************************************************************************/ 
    110110 
    111 /// Resets the error stack for the libLAS C API.   
     111/** Resets the error stack for the libLAS C API.   
     112*/ 
    112113LAS_DLL void LASError_Reset(void); 
    113114 
    114 /// Pops the top error off of the error stack for the libLAS C API. 
     115/** Pops the top error off of the error stack for the libLAS C API. 
     116*/ 
    115117LAS_DLL void LASError_Pop(void); 
    116118 
    117 /// Returns the error number of the last error on the error stack. 
    118 /// @return the error number of the last error on the error stack. 
     119/** Returns the error number of the last error on the error stack. 
     120 *  @return the error number of the last error on the error stack. 
     121*/ 
    119122LAS_DLL LASError LASError_GetLastErrorNum(void); 
    120123 
    121 /// Returns the name of the method the last error message happened in. 
    122 /// @return the name of the method the last error message happened in. 
     124/** Returns the name of the method the last error message happened in. 
     125 *  @return the name of the method the last error message happened in. 
     126*/ 
    123127LAS_DLL char * LASError_GetLastErrorMsg(void); 
    124128 
    125 /// Returns the name of the method the last error message happened in. 
    126 /// @return the name of the method the last error message happened in. 
     129/** Returns the name of the method the last error message happened in. 
     130 *  @return the name of the method the last error message happened in. 
     131*/ 
    127132LAS_DLL char * LASError_GetLastErrorMethod(void); 
    128133 
    129 /// Returns the number of error messages on the error stack. 
    130 /// @return the number of error messages on the error stack. 
     134/** Returns the number of error messages on the error stack. 
     135 *  @return the number of error messages on the error stack. 
     136*/ 
    131137LAS_DLL int LASError_GetErrorCount(void); 
    132138 
    133 /// Prints the last error message in the error stack to stderr.  If  
    134 /// there is no error on the error stack, only the message is printed. 
    135 /// The function does not alter the error stack in any way. 
    136 /// @param message Message to include in the stderr output 
     139/** Prints the last error message in the error stack to stderr.  If  
     140 *  there is no error on the error stack, only the message is printed. 
     141 *  The function does not alter the error stack in any way. 
     142 *  @param message Message to include in the stderr output 
     143*/ 
    137144LAS_DLL void LASError_Print(const char* message); 
    138145 
    … …  
    141148/****************************************************************************/ 
    142149 
    143 /// Creates a LASReaderH object that can be used to read LASHeaderH and  
    144 /// LASPointH objects with.  The LASReaderH must not be created with a  
    145 /// filename that is opened for read or write by any other API functions. 
    146 /// @return opaque pointer to a LASReaderH instance. 
    147 /// @param filename Filename to open for read  
     150/** Creates a LASReaderH object that can be used to read LASHeaderH and  
     151 *  LASPointH objects with.  The LASReaderH must not be created with a  
     152 *  filename that is opened for read or write by any other API functions. 
     153 *  @return opaque pointer to a LASReaderH instance. 
     154 *  @param filename Filename to open for read  
     155*/ 
    148156LAS_DLL LASReaderH LASReader_Create(const char * filename); 
    149157 
    150 /// Reads the next available point on the LASReaderH instance.  If no point  
    151 /// is available to read, NULL is returned.  If an error happens during  
    152 /// the reading of the next available point, an error will be added to the  
    153 /// error stack and can be returned with the LASError_GetLastError* methods. 
    154 /// @param hReader the opaque handle to the LASReaderH  
    155 /// @return an opaque handle to a LASPointH object, or NULL if no point is  
    156 /// available to read or an error occured.  Use the  
    157 /// LASError_GetLastError* methods to confirm the existence of an error  
    158 /// if NULL is returned. 
     158/** Reads the next available point on the LASReaderH instance.  If no point  
     159 *  is available to read, NULL is returned.  If an error happens during  
     160 *  the reading of the next available point, an error will be added to the  
     161 *  error stack and can be returned with the LASError_GetLastError* methods. 
     162 *  @param hReader the opaque handle to the LASReaderH  
     163 *  @return an opaque handle to a LASPointH object, or NULL if no point is  
     164 *  available to read or an error occured.  Use the  
     165 *  LASError_GetLastError* methods to confirm the existence of an error  
     166 *  if NULL is returned. 
     167*/ 
    159168LAS_DLL LASPointH LASReader_GetNextPoint(const LASReaderH hReader); 
    160169 
    161 /// Reads a LASPointH from the given position in the LAS file represented  
    162 /// by the LASReaderH instance.  If no point is available at that location,  
    163 /// NULL is returned.  If an error happens during the reading of the point,  
    164 /// an error will be added to the error stack and can be returned with the  
    165 /// LASError_GetLastError* methods. 
    166 /// @param hReader the opaque handle to the LASReaderH 
    167 /// @param position the integer position of the point in the file to read. 
    168 /// @return an opaque handle to a LASPointH object, or NULL if no point is  
    169 /// available at the given location or an error occured.  Use the  
    170 /// LASError_GetLastError* methods to confirm the existence of an error  
    171 /// if NULL is returned. 
     170/** Reads a LASPointH from the given position in the LAS file represented  
     171 *  by the LASReaderH instance.  If no point is available at that location,  
     172 *  NULL is returned.  If an error happens during the reading of the point,  
     173 *  an error will be added to the error stack and can be returned with the  
     174 *  LASError_GetLastError* methods. 
     175 *  @param hReader the opaque handle to the LASReaderH 
     176 *  @param position the integer position of the point in the file to read. 
     177 *  @return an opaque handle to a LASPointH object, or NULL if no point is  
     178 *  available at the given location or an error occured.  Use the  
     179 *  LASError_GetLastError* methods to confirm the existence of an error  
     180 *  if NULL is returned. 
     181*/ 
    172182LAS_DLL LASPointH LASReader_GetPointAt(const LASReaderH hReader, uint32_t position); 
    173183 
    174 /// Closes the file for reading operations represented by the LASReaderH instance. 
    175 /// @param hReader the opqaue handle to the LASReaderH 
     184/** Closes the file for reading operations represented by the LASReaderH instance. 
     185 *  @param hReader the opqaue handle to the LASReaderH 
     186*/ 
    176187LAS_DLL void LASReader_Destroy(LASReaderH hReader); 
    177188