api: move documentation to .h and discontinue on static functions

While Doxygen correctly locates the function documentation when it is
written directly preceding the function body, Microsoft Visual Studio
IDE does not. The former requires the documentation to precede the
function declaration.

Signed-off-by: Simon Rozman <simon@rozman.si>

1 files changed, 0 insertions, 120 deletions

diff --git a/api/registry.c b/api/registry.c
index e752469..a36b27e 100644
--- a/api/registry.c
+++ b/api/registry.c
@@ -57,21 +57,6 @@ OpenKeyWait(_In_ HKEY Key, _Inout_z_ WCHAR *Path, _In_ DWORD Access, _In_ ULONGL
     return Result;
 }
 
-/**
- * Opens the specified registry key. It waits for the registry key to become available.
- *
- * @param Key           Handle of the parent registry key. Must be opened with notify access.
- *
- * @param Path          Subpath of the registry key to open.
- *
- * @param Access        A mask that specifies the desired access rights to the key to be opened.
- *
- * @param Timeout       Timeout to wait for the value in milliseconds.
- *
- * @param KeyOut        Pointer to a variable to receive the key handle.
- *
- * @return ERROR_SUCCESS on success; WAIT_TIMEOUT on timeout; Win32 error code otherwise.
- */
 WINTUN_STATUS
 RegistryOpenKeyWait(
     _In_ HKEY Key,
@@ -85,21 +70,6 @@ RegistryOpenKeyWait(
     return OpenKeyWait(Key, Buf, Access, GetTickCount64() + Timeout, KeyOut);
 }
 
-/**
- * Validates and/or sanitizes string value read from registry.
- *
- * @param Buf           On input, it contains a pointer to pointer where the data is stored. The data must be allocated
- *                      using HeapAlloc(GetProcessHeap(), 0). On output, it contains a pointer to pointer where the
- *                      sanitized data is stored. It must be released with HeapFree(GetProcessHeap(), 0, *Buf) after
- *                      use.
- *
- * @param Len           Length of data string in wide characters.
- *
- * @param ValueType     Type of data. Must be either REG_SZ or REG_EXPAND_SZ. REG_MULTI_SZ is treated like REG_SZ; only
- *                      the first string of a multi-string is to be used.
- *
- * @return ERROR_SUCCESS on success; Win32 error code otherwise.
- */
 WINTUN_STATUS
 RegistryGetString(_Inout_ WCHAR **Buf, _In_ DWORD Len, _In_ DWORD ValueType)
 {
@@ -150,20 +120,6 @@ RegistryGetString(_Inout_ WCHAR **Buf, _In_ DWORD Len, _In_ DWORD ValueType)
     }
 }
 
-/**
- * Validates and/or sanitizes multi-string value read from registry.
- *
- * @param Buf           On input, it contains a pointer to pointer where the data is stored. The data must be allocated
- *                      using HeapAlloc(GetProcessHeap(), 0). On output, it contains a pointer to pointer where the
- *                      sanitized data is stored. It must be released with HeapFree(GetProcessHeap(), 0, *Buf) after
- *                      use.
- *
- * @param Len           Length of data string in wide characters.
- *
- * @param ValueType     Type of data. Must be one of REG_MULTI_SZ, REG_SZ or REG_EXPAND_SZ.
- *
- * @return ERROR_SUCCESS on success; Win32 error code otherwise.
- */
 WINTUN_STATUS
 RegistryGetMultiString(_Inout_ WCHAR **Buf, _In_ DWORD Len, _In_ DWORD ValueType)
 {
@@ -218,24 +174,6 @@ RegistryGetMultiString(_Inout_ WCHAR **Buf, _In_ DWORD Len, _In_ DWORD ValueType
     return ERROR_SUCCESS;
 }
 
-/**
- * Retrieves the type and data for the specified value name associated with an open registry key.
- *
- * @param Key           Handle of the registry key to read from. Must be opened with read access.
- *
- * @param Name          Name of the value to read.
- *
- * @param ValueType     A pointer to a variable that receives a code indicating the type of data stored in the specified
- *                      value.
- *
- * @param Buf           Pointer to a pointer to retrieve registry value. The buffer must be released with
- *                      HeapFree(GetProcessHeap(), 0, *Buf) after use.
- *
- * @param BufLen        On input, a hint of expected registry value size in bytes; on output, actual registry value size
- *                      in bytes.
- *
- * @return ERROR_SUCCESS on success; Win32 error code otherwise.
- */
 static WINTUN_STATUS
 RegistryQuery(
     _In_ HKEY Key,
@@ -259,21 +197,6 @@ RegistryQuery(
     }
 }
 
-/**
- * Reads string value from registry key.
- *
- * @param Key           Handle of the registry key to read from. Must be opened with read access.
- *
- * @param Name          Name of the value to read.
- *
- * @param Value         Pointer to string to retrieve registry value. If the value type is REG_EXPAND_SZ the value is
- *                      expanded using ExpandEnvironmentStrings(). If the value type is REG_MULTI_SZ, only the first
- *                      string from the multi-string is returned. The string must be released with
- *                      HeapFree(GetProcessHeap(), 0, Value) after use.
- *
- * @return ERROR_SUCCESS on success; ERROR_INVALID_DATATYPE when the registry value is not a string; Win32 error code
- * otherwise.
- */
 WINTUN_STATUS
 RegistryQueryString(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _Out_ WCHAR **Value)
 {
@@ -297,23 +220,6 @@ RegistryQueryString(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _Out_ WCHAR **V
     }
 }
 
-/**
- * Reads string value from registry key. It waits for the registry value to become available.
- *
- * @param Key           Handle of the registry key to read from. Must be opened with read and notify access.
- *
- * @param Name          Name of the value to read.
- *
- * @param Timeout       Timeout to wait for the value in milliseconds.
- *
- * @param Value         Pointer to string to retrieve registry value. If the value type is REG_EXPAND_SZ the value is
- *                      expanded using ExpandEnvironmentStrings(). If the value type is REG_MULTI_SZ, only the first
- *                      string from the multi-string is returned. The string must be released with
- *                      HeapFree(GetProcessHeap(), 0, Value) after use.
- *
- * @return ERROR_SUCCESS on success; WAIT_TIMEOUT on timeout; ERROR_INVALID_DATATYPE when the registry value is not a
- * string; Win32 error code otherwise.
- */
 WINTUN_STATUS
 RegistryQueryStringWait(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _In_ DWORD Timeout, _Out_ WCHAR **Value)
 {
@@ -346,18 +252,6 @@ RegistryQueryStringWait(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _In_ DWORD
     return Result;
 }
 
-/**
- * Reads a 32-bit DWORD value from registry key.
- *
- * @param Key           Handle of the registry key to read from. Must be opened with read access.
- *
- * @param Name          Name of the value to read.
- *
- * @param Value         Pointer to DWORD to retrieve registry value.
- *
- * @return ERROR_SUCCESS on success; ERROR_INVALID_DATATYPE when registry value exist but not REG_DWORD type;
- * ERROR_INVALID_DATA when registry value size is not 4 bytes; Win32 error code otherwise.
- */
 WINTUN_STATUS
 RegistryQueryDWORD(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _Out_ DWORD *Value)
 {
@@ -378,20 +272,6 @@ RegistryQueryDWORD(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _Out_ DWORD *Val
     return ERROR_SUCCESS;
 }
 
-/**
- * Reads a 32-bit DWORD value from registry key. It waits for the registry value to become available.
- *
- * @param Key           Handle of the registry key to read from. Must be opened with read access.
- *
- * @param Name          Name of the value to read.
- *
- * @param Timeout       Timeout to wait for the value in milliseconds.
- *
- * @param Value         Pointer to DWORD to retrieve registry value.
- *
- * @return ERROR_SUCCESS on success; WAIT_TIMEOUT on timeout; ERROR_INVALID_DATATYPE when registry value exist but not
- * REG_DWORD type; ERROR_INVALID_DATA when registry value size is not 4 bytes; Win32 error code otherwise.
- */
 WINTUN_STATUS
 RegistryQueryDWORDWait(_In_ HKEY Key, _In_opt_z_ const WCHAR *Name, _In_ DWORD Timeout, _Out_ DWORD *Value)
 {