Changeset 659

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

doc updates

Files:
1 modified

Legend:

Unmodified
Added
Removed

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

    r658 r659  
    100100 
    101101 
    102 /// Returns the version string for this library. 
    103 /// @return the version string for this library. 
     102/* Returns the version string for this library. 
     103 @return the version string for this library. 
     104*/ 
    104105LAS_DLL const char* LAS_GetVersion(); 
     106 
     107/****************************************************************************/ 
     108/* Error handling                                                           */ 
     109/****************************************************************************/ 
    105110 
    106111/// Resets the error stack for the libLAS C API.   
    … …  
    131136/// @param message Message to include in the stderr output 
    132137LAS_DLL void LASError_Print(const char* message); 
     138 
     139/****************************************************************************/ 
     140/* Reader operations                                                        */ 
     141/****************************************************************************/ 
    133142 
    134143/// Creates a LASReaderH object that can be used to read LASHeaderH and  
    … …  
    163172LAS_DLL LASPointH LASReader_GetPointAt(const LASReaderH hReader, uint32_t position); 
    164173 
     174/// Closes the file for reading operations represented by the LASReaderH instance. 
     175/// @param hReader the opqaue handle to the LASReaderH 
    165176LAS_DLL void LASReader_Destroy(LASReaderH hReader); 
    166177 
    167 LAS_DLL double LASPoint_GetX(const LASPointH); 
     178/****************************************************************************/ 
     179/* Point operations                                                         */ 
     180/****************************************************************************/ 
     181 
     182 
     183LAS_DLL double LASPoint_GetX(const LASPointH hPoint); 
    168184LAS_DLL LASError LASPoint_SetX(LASPointH hPoint, double value); 
    169 LAS_DLL double LASPoint_GetY(const LASPointH); 
     185LAS_DLL double LASPoint_GetY(const LASPointH hPoint); 
    170186LAS_DLL LASError LASPoint_SetY(LASPointH hPoint, double value); 
    171 LAS_DLL double LASPoint_GetZ(const LASPointH); 
     187LAS_DLL double LASPoint_GetZ(const LASPointH hPoint); 
    172188LAS_DLL LASError LASPoint_SetZ(LASPointH hPoint, double value); 
    173189 
    174 LAS_DLL uint16_t LASPoint_GetIntensity(const LASPointH); 
     190LAS_DLL uint16_t LASPoint_GetIntensity(const LASPointH hPoint); 
    175191LAS_DLL LASError LASPoint_SetIntensity(LASPointH hPoint, uint16_t value); 
    176192 
    177 LAS_DLL uint16_t LASPoint_GetReturnNumber(const LASPointH); 
     193LAS_DLL uint16_t LASPoint_GetReturnNumber(const LASPointH hPoint); 
    178194LAS_DLL LASError LASPoint_SetReturnNumber(LASPointH hPoint, uint16_t value); 
    179 LAS_DLL uint16_t LASPoint_GetNumberOfReturns(const LASPointH); 
     195LAS_DLL uint16_t LASPoint_GetNumberOfReturns(const LASPointH hPoint); 
    180196LAS_DLL LASError LASPoint_SetNumberOfReturns(LASPointH hPoint, uint16_t value); 
    181 LAS_DLL uint16_t LASPoint_GetScanDirection(const LASPointH); 
     197LAS_DLL uint16_t LASPoint_GetScanDirection(const LASPointH hPoint); 
    182198LAS_DLL LASError LASPoint_SetScanDirection(LASPointH hPoint, uint16_t value); 
    183 LAS_DLL uint16_t LASPoint_GetFlightLineEdge(const LASPointH); 
     199LAS_DLL uint16_t LASPoint_GetFlightLineEdge(const LASPointH hPoint); 
    184200LAS_DLL LASError LASPoint_SetFlightLineEdge(LASPointH hPoint, uint16_t value); 
    185 LAS_DLL uint8_t LASPoint_GetScanFlags(const LASPointH); 
     201LAS_DLL uint8_t LASPoint_GetScanFlags(const LASPointH hPoint); 
    186202LAS_DLL LASError LASPoint_SetScanFlags(LASPointH hPoint, uint8_t value); 
    187 LAS_DLL uint8_t LASPoint_GetClassification(const LASPointH); 
     203LAS_DLL uint8_t LASPoint_GetClassification(const LASPointH hPoint); 
    188204LAS_DLL LASError LASPoint_SetClassification(LASPointH hPoint, uint8_t value); 
    189 LAS_DLL double LASPoint_GetTime(const LASPointH); 
     205LAS_DLL double LASPoint_GetTime(const LASPointH hPoint); 
    190206LAS_DLL LASError LASPoint_SetTime(LASPointH hPoint, double value); 
    191 LAS_DLL int8_t LASPoint_GetScanAngleRank(const LASPointH); 
     207LAS_DLL int8_t LASPoint_GetScanAngleRank(const LASPointH hPoint); 
    192208LAS_DLL LASError LASPoint_SetScanAngleRank(LASPointH hPoint, int8_t value); 
    193 LAS_DLL uint8_t LASPoint_GetUserData(const LASPointH); 
     209LAS_DLL uint8_t LASPoint_GetUserData(const LASPointH hPoint); 
    194210LAS_DLL LASError LASPoint_SetUserData(LASPointH hPoint, uint8_t value); 
    195211LAS_DLL int LASPoint_Validate(LASPointH hPoint);