--- 3d-viewer/3d_cache/3d_cache.h | 22 ++++++++++++---------- 3d-viewer/3d_cache/3d_filename_resolver.h | 7 ++++--- 2 files changed, 16 insertions(+), 13 deletions(-)
diff --git a/3d-viewer/3d_cache/3d_cache.h b/3d-viewer/3d_cache/3d_cache.h index d2bd760c5..376b529f5 100644 --- a/3d-viewer/3d_cache/3d_cache.h +++ b/3d-viewer/3d_cache/3d_cache.h @@ -74,15 +74,16 @@ private: /// current KiCad project dir wxString m_ProjDir; - /** - * Function checkCache - * searches the cache list for the given filename and retrieves + /** Find or create cache entry for file name + * + * Searches the cache list for the given filename and retrieves * the cache data; a cache entry is created if one does not - * already exist + * already exist. * - * @param aFileName [in] is a partial or full file path - * @param [out] if not NULL will hold a pointer to the cache entry for the model - * @return on success a pointer to a SCENEGRAPH, otherwise NULL + * @param[in] aFileName file name (full or partial path) + * @param[out] aCachePtr optional return address for cache entry pointer + * @return SCENEGRAPH object associated with file name + * @retval NULL on error */ SCENEGRAPH* checkCache( const wxString& aFileName, S3D_CACHE_ENTRY** aCachePtr = NULL ); @@ -90,9 +91,10 @@ private: * Function getSHA1 * calculates the SHA1 hash of the given file * - * @param aFileName [in] is a fully qualified path to the model file - * @param aSHA1Sum [out] is a 20-byte character array to hold the SHA1 hash - * @return true if the sha1 hash was calculated; otherwise false + * @param[in] aFileName file name (full path) + * @param[out] aSHA1Sum a 20 byte character array to hold the SHA1 hash + * @retval true success + * @retval false failure */ bool getSHA1( const wxString& aFileName, unsigned char* aSHA1Sum ); diff --git a/3d-viewer/3d_cache/3d_filename_resolver.h b/3d-viewer/3d_cache/3d_filename_resolver.h index 4c5e4a876..432bbb70c 100644 --- a/3d-viewer/3d_cache/3d_filename_resolver.h +++ b/3d-viewer/3d_cache/3d_filename_resolver.h @@ -122,9 +122,10 @@ public: * sets the current KiCad project directory as the first * entry in the model path list * - * @param aProjDir is the current project directory - * @param flgChanged, if specified, is set to true if the directory actually changed - * @return true if the call succeeds + * @param[in] aProjDir current project directory + * @param[out] flgChanged optional, set to true if directory was changed + * @retval true success + * @retval false failure */ bool SetProjectDir( const wxString& aProjDir, bool* flgChanged = NULL ); wxString GetProjectDir( void );
_______________________________________________ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp