sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

BaseTools: Source/C/Common: Fix doc block locations and convert to Doxygen

Browse Source 
Move the documentation blocks from between the parameter list and function
body to above the function.

Convert all the documentation blocks to Doxygen format.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>
This commit is contained in:
Rebecca Cran
2023-02-19 23:21:43 -07:00
committed by mergify[bot]
parent cf6a0a52b0
commit b4e2cf092a
29 changed files with 2112 additions and 4105 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
BaseTools/Source/C/Common/OsPath.c
View File

@ -20,14 +20,8 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
//
// BUGBUG: Not fully implemented yet.
//
CHAR8*
OsPathDirName (
IN CHAR8 *FilePath
)
/*++
Routine Description:
/**
This function returns the directory path which contains the particular path.
Some examples:
"a/b/c" -> "a/b"
@ -40,15 +34,15 @@ Routine Description:
The caller must free the string returned.
Arguments:
@param FilePath Path name of file to get the parent directory for.
FilePath Path name of file to get the parent directory for.
@return NULL if error
**/
CHAR8*
OsPathDirName (
IN CHAR8 *FilePath
)
Returns:
NULL if error
--*/
{
CHAR8 *Return;
CHAR8 *Pos;
@ -97,14 +91,8 @@ Returns:
//
// BUGBUG: Not fully implemented yet.
//
VOID
OsPathNormPathInPlace (
IN CHAR8 *Path
)
/*++
Routine Description:
/**
This function returns the directory path which contains the particular path.
Some examples:
"a/b/../c" -> "a/c"
@ -113,15 +101,14 @@ Routine Description:
This function does not check for the existence of the file.
Arguments:
@param Path Path name of file to normalize
Path Path name of file to normalize
Returns:
The string is altered in place.
--*/
@return The string is altered in place.
**/
VOID
OsPathNormPathInPlace (
IN CHAR8 *Path
)
{
CHAR8 *Pos;
INTN Offset;
@ -200,16 +187,7 @@ Returns:
}
#endif
CHAR8*
OsPathPeerFilePath (
IN CHAR8 *OldPath,
IN CHAR8 *Peer
)
/*++
Routine Description:
/**
This function replaces the final portion of a path with an alternative
'peer' filename. For example:
"a/b/../c", "peer" -> "a/b/../peer"
@ -219,16 +197,16 @@ Routine Description:
This function does not check for the existence of the file.
Arguments:
@param OldPath Path name of replace the final segment
@param Peer The new path name to concatenate to become the peer path
OldPath Path name of replace the final segment
Peer The new path name to concatenate to become the peer path
Returns:
A CHAR8* string, which must be freed by the caller
--*/
@return A CHAR8* string, which must be freed by the caller
**/
CHAR8*
OsPathPeerFilePath (
IN CHAR8 *OldPath,
IN CHAR8 *Peer
)
{
CHAR8 *Result;
INTN Offset;
@ -259,27 +237,18 @@ Returns:
return Result;
}
/**
Checks if a file exists
@param InputFileName The name of the file to check for existence
@retval TRUE The file exists
@retval FALSE The file does not exist
**/
BOOLEAN
OsPathExists (
IN CHAR8 *InputFileName
)
/*++
Routine Description:
Checks if a file exists
Arguments:
InputFileName The name of the file to check for existence
Returns:
TRUE The file exists
FALSE The file does not exist
--*/
{
FILE *InputFile;
InputFile = fopen (LongFilePath (InputFileName), "rb");