haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen improvements

This commit is contained in:
Simon Richter 2017-06-11 07:38:09 +02:00 committed by Wayne Stambaugh
parent a9ca1e9930
commit d5e85726ea
2 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
3d-viewer/3d_cache/3d_cache.h
View File

@ -74,15 +74,16 @@ private:
/// current KiCad project dir /// current KiCad project dir
wxString m_ProjDir; wxString m_ProjDir;
/** /** Find or create cache entry for file name
* Function checkCache
* searches the cache list for the given filename and retrieves
* the cache data; a cache entry is created if one does not
* already exist
* *
* @param aFileName [in] is a partial or full file path * Searches the cache list for the given filename and retrieves
* @param [out] if not NULL will hold a pointer to the cache entry for the model * the cache data; a cache entry is created if one does not
* @return on success a pointer to a SCENEGRAPH, otherwise NULL * already exist.
*
* @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 ); SCENEGRAPH* checkCache( const wxString& aFileName, S3D_CACHE_ENTRY** aCachePtr = NULL );
@ -90,9 +91,10 @@ private:
* Function getSHA1 * Function getSHA1
* calculates the SHA1 hash of the given file * calculates the SHA1 hash of the given file
* *
* @param aFileName [in] is a fully qualified path to the model file * @param[in] aFileName file name (full path)
* @param aSHA1Sum [out] is a 20-byte character array to hold the SHA1 hash * @param[out] aSHA1Sum a 20 byte character array to hold the SHA1 hash
* @return true if the sha1 hash was calculated; otherwise false * @retval true success
* @retval false failure
*/ */
bool getSHA1( const wxString& aFileName, unsigned char* aSHA1Sum ); bool getSHA1( const wxString& aFileName, unsigned char* aSHA1Sum );

7
3d-viewer/3d_cache/3d_filename_resolver.h
View File

@ -122,9 +122,10 @@ public:
* sets the current KiCad project directory as the first * sets the current KiCad project directory as the first
* entry in the model path list * entry in the model path list
* *
* @param aProjDir is the current project directory * @param[in] aProjDir current project directory
* @param flgChanged, if specified, is set to true if the directory actually changed * @param[out] flgChanged optional, set to true if directory was changed
* @return true if the call succeeds * @retval true success
* @retval false failure
*/ */
bool SetProjectDir( const wxString& aProjDir, bool* flgChanged = NULL ); bool SetProjectDir( const wxString& aProjDir, bool* flgChanged = NULL );
wxString GetProjectDir( void ); wxString GetProjectDir( void );