[Winmerge-svn] SF.net SVN: winmerge: [3845] trunk/Src
Windows visual diff and merge for files and directories
Brought to you by:
christianlist,
grimmdp
From: <ki...@us...> - 2006-11-24 22:32:39
|
Revision: 3845 http://svn.sourceforge.net/winmerge/?rev=3845&view=rev Author: kimmov Date: 2006-11-24 14:32:35 -0800 (Fri, 24 Nov 2006) Log Message: ----------- Fix bunch of doxygen warnings (wrong parameter names etc) Modified Paths: -------------- trunk/Src/Changes.txt trunk/Src/CmdLineParser.h trunk/Src/DiffWrapper.cpp trunk/Src/DirDoc.cpp trunk/Src/FilepathEdit.cpp trunk/Src/PropEditor.cpp trunk/Src/WMGotoDlg.h trunk/Src/files.cpp trunk/Src/paths.cpp Modified: trunk/Src/Changes.txt =================================================================== --- trunk/Src/Changes.txt 2006-11-23 19:54:31 UTC (rev 3844) +++ trunk/Src/Changes.txt 2006-11-24 22:32:35 UTC (rev 3845) @@ -2,6 +2,11 @@ Add new items to top. (This summarizes all changes to all files under Src, including Src\Languages.) +2006-11-24 Kimmo + Fix bunch of doxygen warnings (wrong parameter names etc) + Src: CmdLineParser.h DiffWrapper.cpp DirDoc.cpp FilepathEdit.cpp files.cpp + paths.cpp PropEditor.cpp WMGotoDlg.h + 2006-11-23 WinMerge experimental release 2.7.1.2 (SVN revision 3844) 2006-11-23 Kimmo Modified: trunk/Src/CmdLineParser.h =================================================================== --- trunk/Src/CmdLineParser.h 2006-11-23 19:54:31 UTC (rev 3844) +++ trunk/Src/CmdLineParser.h 2006-11-24 22:32:35 UTC (rev 3845) @@ -68,11 +68,10 @@ * actual parsing. * * @param [in] pszParam The parameter or flag. - * @bFlag [in] bFlag Indicates whether pszParam is a parameter or a + * @param [in] bFlag Indicates whether pszParam is a parameter or a * flag. - * @bLast [in] bLast Indicates if this is the last parameter or flag + * @param [in] bLast Indicates if this is the last parameter or flag * on the command line. - * */ virtual void ParseParam(const TCHAR* pszParam, BOOL bFlag, BOOL bLast) = 0; Modified: trunk/Src/DiffWrapper.cpp =================================================================== --- trunk/Src/DiffWrapper.cpp 2006-11-23 19:54:31 UTC (rev 3844) +++ trunk/Src/DiffWrapper.cpp 2006-11-24 22:32:35 UTC (rev 3845) @@ -132,7 +132,7 @@ * This function enables or disables DiffList creation. When * @p diffList is NULL difflist is not created. When valid DiffList * pointer is given, compare results are stored into it. - * @param [in] difflist Pointer to DiffList getting compare results. + * @param [in] diffList Pointer to DiffList getting compare results. */ void CDiffWrapper::SetCreateDiffList(DiffList *diffList) { @@ -603,8 +603,8 @@ /** * @brief Set source paths for original (NON-TEMP) diffing two files. * Sets full paths to two (NON-TEMP) files we are diffing. - * @param [in] filepath1 First file to compare "(NON-TEMP) file". - * @param [in] filepath2 Second file to compare "(NON-TEMP) file". + * @param [in] OriginalFile1 First file to compare "(NON-TEMP) file". + * @param [in] OriginalFile2 Second file to compare "(NON-TEMP) file". */ void CDiffWrapper::SetCompareFiles(const CString &OriginalFile1, const CString &OriginalFile2) { Modified: trunk/Src/DirDoc.cpp =================================================================== --- trunk/Src/DirDoc.cpp 2006-11-23 19:54:31 UTC (rev 3844) +++ trunk/Src/DirDoc.cpp 2006-11-24 22:32:35 UTC (rev 3845) @@ -335,12 +335,9 @@ } /** - * @brief Determines if user wants to see this item - * @param [in] pCtxt CDiffContext containing filedata - * @param [in] di Item tested - * @param [in] llen Lenght of normalised left path - * @param [in] rlen Lenght of normalised right path - * @return File- or subfolder name of item, NULL if user does not want to see it + * @brief Determines if the user wants to see given item. + * @param [in] di Item to check. + * @return TRUE if item should be shown, FALSE if not. * @sa CDirDoc::Redisplay() */ BOOL CDirDoc::IsShowable(const DIFFITEM & di) Modified: trunk/Src/FilepathEdit.cpp =================================================================== --- trunk/Src/FilepathEdit.cpp 2006-11-23 19:54:31 UTC (rev 3844) +++ trunk/Src/FilepathEdit.cpp 2006-11-24 22:32:35 UTC (rev 3845) @@ -53,8 +53,8 @@ * slash chars. * * @param [in] pDC Pointer to draw context. - * @param [in] nMaxWidth Maximum width of string. - * @param [in,out] sFilePath: + * @param [in] maxWidth Maximum width of string. + * @param [in,out] sFilepath: * - in: string to format * - out: formatted string * @return Number of lines path is splitted to. Modified: trunk/Src/PropEditor.cpp =================================================================== --- trunk/Src/PropEditor.cpp 2006-11-23 19:54:31 UTC (rev 3844) +++ trunk/Src/PropEditor.cpp 2006-11-24 22:32:35 UTC (rev 3845) @@ -150,7 +150,7 @@ /** * @brief Shortcut to enable or disable a control * @param [in] item ID of dialog control to enable/disable. - * @paran [in] enable if true control is enabled, else disabled. + * @param [in] enable if true control is enabled, else disabled. */ void CPropEditor::EnableDlgItem(int item, bool enable) { Modified: trunk/Src/WMGotoDlg.h =================================================================== --- trunk/Src/WMGotoDlg.h 2006-11-23 19:54:31 UTC (rev 3844) +++ trunk/Src/WMGotoDlg.h 2006-11-24 22:32:35 UTC (rev 3845) @@ -15,7 +15,7 @@ // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. ///////////////////////////////////////////////////////////////////////////// /** - * @file WMGotodDlg.h + * @file WMGotoDlg.h * * @brief Declaration file for CWMGotoDlg * Modified: trunk/Src/files.cpp =================================================================== --- trunk/Src/files.cpp 2006-11-23 19:54:31 UTC (rev 3844) +++ trunk/Src/files.cpp 2006-11-24 22:32:35 UTC (rev 3845) @@ -155,8 +155,8 @@ /** * @brief Checks if file is read-only on disk. * Optionally returns also if file exists. - * @param [in] Full path to file to check. - * @param [in, out] If non-NULL, returns if file exists. + * @param [in] file Full path to file to check. + * @param [in, out] fileExists If non-NULL, function returns if file exists. * @return TRUE if file is read-only, FALSE otherwise. */ BOOL files_isFileReadOnly(const CString &file, BOOL *fileExists /*=NULL*/) Modified: trunk/Src/paths.cpp =================================================================== --- trunk/Src/paths.cpp 2006-11-23 19:54:31 UTC (rev 3844) +++ trunk/Src/paths.cpp 2006-11-24 22:32:35 UTC (rev 3845) @@ -18,7 +18,7 @@ /** * @brief Checks if char in string is slash. * @param [in] pszStart String to check. - * @param [in] Position of char in string to check (0-based index). + * @param [in] nPos of char in string to check (0-based index). * @return true if char is slash. */ static bool IsSlash(LPCTSTR pszStart, int nPos) @@ -441,7 +441,7 @@ * This function appends subpath to given path. Function ensures there * is only one backslash between path parts. * @param [in] path "Base" path where other part is appended. - * @param [in] subPath Path part to append to base part. + * @param [in] subpath Path part to append to base part. * @return Formatted path. If one of arguments is empty then returns * non-empty argument. If both argumets are empty empty string is returned. */ @@ -476,7 +476,7 @@ /** * @brief Get parent path. * This function returns parent path for given path. For example for - * path "c:\folder\subfolder" we return "c:\folder. + * path "c:\folder\subfolder" we return "c:\folder". * @param [in] path Path to get parent path for. * @return Parent path. */ This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |