[PATCH] Add NTDLL atom.c documentation (revised).
max at mtew.isa-geek.net
max at mtew.isa-geek.net
Sun Mar 6 08:57:01 CST 2011
From: Max TenEyck Woodbury <max at mtew.isa-geek.net>
---
dlls/ntdll/atom.c | 53 ++++++++++++++++++++++++-----------------------------
1 files changed, 24 insertions(+), 29 deletions(-)
diff --git a/dlls/ntdll/atom.c b/dlls/ntdll/atom.c
index 5b71b76..0f73d02 100644
--- a/dlls/ntdll/atom.c
+++ b/dlls/ntdll/atom.c
@@ -92,13 +92,13 @@ done:
/******************************************************************
* RtlDeleteAtomFromAtomTable (NTDLL.@)
+ * RtlDeleteAtomFromAtomTable (NTOSKRNL.@)
+ *
* Delete the atom 'atom' from the atom table 'table'.
* RETURNS
*| Type NTSTATUS.
*| STATUS_INVALID_PARAMETER if 'table' is null.
*| status from the Wine server request.
- * FORWARDS
- *| From ntoskrnl.exe:RtlDeleteAtomFromAtomTable.
* TESTS
* tests/atom.c
* SEARCH
@@ -162,7 +162,8 @@ static ULONG integral_atom_name(
/******************************************************************
* RtlQueryAtomInAtomTable (NTDLL.@)
- * DESCRIPTION
+ * RtlQueryAtomInAtomTable (NTOSKRNL.@)
+ *
* Get the string and statistics associated with an atom handle from an atom
* table.
* RETURNS
@@ -178,8 +179,6 @@ static ULONG integral_atom_name(
* Truncate/terminate returned 'name'.
* DEFECTS
* Accessability of 'ref', 'pin', 'name' and 'len' not checked.
- * FORWARDS FROM
- *| ntoskrnl.exe
* TESTS
* tests/atom.c
* SEARCH
@@ -242,6 +241,8 @@ NTSTATUS WINAPI RtlQueryAtomInAtomTable(
/******************************************************************
* RtlCreateAtomTable (NTDLL.@)
+ * RtlCreateAtomTable (NTSKRNL.@)
+ *
* Create an atom table.
* RETURNS
*| Type NTSTATUS.
@@ -251,8 +252,6 @@ NTSTATUS WINAPI RtlQueryAtomInAtomTable(
*| Other status values from the Wine server.
* DEFECTS
* Accessability of 'table' not checked.
- * FORWARDS
- *| From ntoskrnl.exe:RtlCreateAtomTable.
* TESTS
* tests/atom.c
* SEARCH
@@ -290,13 +289,12 @@ NTSTATUS WINAPI RtlCreateAtomTable(
/******************************************************************
* RtlDestroyAtomTable (NTDLL.@)
+ * RtlDestroyAtomTable (NTOSKRNL.@)
*
* Discontinue using an atom table.
* RETURNS
*| Type NTSTATUS.
*| Status from NtClose.
- * FORWARDS
- * From ntoskrnl.exe:RtlDestroyAtomTable.
* TESTS
* tests/atom.c
* SEARCH
@@ -315,6 +313,8 @@ NTSTATUS WINAPI RtlDestroyAtomTable(
/******************************************************************
* RtlAddAtomToAtomTable (NTDLL.@)
+ * RtlAddAtomToAtomTable (NTOSKRNL.@)
+ *
* Add a name to an atom table.
* RETURNS
*| Type NTSTATUS
@@ -323,8 +323,6 @@ NTSTATUS WINAPI RtlDestroyAtomTable(
*| Other status values from the Wine server.
* DEFECTS
* Validity of 'atom' not checked. Accessability of 'name' not checked.
- * FORWARDS
- *| from ntoskrnl.exe:RtlAddAtomToAtomTable.
* TESTS
* tests/atom.c
* SEARCH
@@ -367,6 +365,7 @@ NTSTATUS WINAPI RtlAddAtomToAtomTable(
/******************************************************************
* RtlLookupAtomInAtomTable (NTDLL.@)
+ * RtlLookupAtomInAtomTable (NTOSKRNL.@)
*
* Find the atom handle associated with name in an atom table.
* RETURNS
@@ -377,8 +376,6 @@ NTSTATUS WINAPI RtlAddAtomToAtomTable(
* DEFECTS
* Validity of 'name' and 'atom' not checked. Accessability of 'table' not
* checked.
- * FORWARDS
- *| From ntoskrnl.exe:RtlLookupAtomInAtomTable.
* TESTS
* tests/atom.c
* SEARCH
@@ -421,14 +418,13 @@ NTSTATUS WINAPI RtlLookupAtomInAtomTable(
/******************************************************************
* RtlEmptyAtomTable (NTDLL.@)
+ * RtlEmptyAtomTable (NTOSKRNL.@)
*
* Release all the entries in an atom table.
* RETURNS
*| Type NTSTATUS.
*| STATUS_INVALID_PARAMETER if 'table' is null.
*| Other status values from the Wine server.
- * FORWARDS
- * From ntoskrnl.exe:RtlEmptyAtomTable.
* TESTS
* tests/atom.c
* SEARCH
@@ -460,6 +456,7 @@ NTSTATUS WINAPI RtlEmptyAtomTable(
/******************************************************************
* RtlPinAtomInAtomTable (NTDLL.@)
+ * RtlPinAtomInAtomTable (NTOSKRNL.@)
*
* Designate an atom in an atom table as 'pinned'.
* RETURNS
@@ -467,8 +464,6 @@ NTSTATUS WINAPI RtlEmptyAtomTable(
*| STATUS_INVALID_PARAMETER is 'table' is null.
*| STATUS_SUCCESS if 'atom' is an integral atom.
*| Other status values from the Wine server.
- * FORWARDS
- * From ntoskrnl.exe:RtlPinAtomInAtomTable.
* TESTS
* tests/atom.c
* SEARCH
@@ -506,6 +501,9 @@ NTSTATUS WINAPI RtlPinAtomInAtomTable(
/******************************************************************
* NtAddAtom (NTDLL.@)
+ * ZwAddAtom (NTDLL.@)
+ * NtAddAtom (NTOSKRNL.@)
+ *
* Insert a name into the global atom table.
* RETURNS
*| Type NTSTATUS.
@@ -515,9 +513,6 @@ NTSTATUS WINAPI RtlPinAtomInAtomTable(
*| Status values from the Wine server.
* DEFECTS
* Validity of 'name' and 'atom' are not checked.
- * FORWARDS
- *| From ntoskrnl.exe:NtAddAtom.
- *| From ntdll:ZwAddAtom.
* TESTS
* tests/atom.c
* SEARCH
@@ -554,13 +549,13 @@ NTSTATUS WINAPI NtAddAtom(
/******************************************************************
* NtDeleteAtom (NTDLL.@)
+ * ZwDeleteAtom (NTDLL.@)
+ * NtDeleteAtom (NTOSKRNL.@)
+ *
* Delete the atom from the global atom table.
* RETURNS
*| Type NTSTATUS
*| Status values from the Wine server.
- * FORWARDS
- *| From ntoskrnl.exe:NtDeleteAtom
- *| From ntdll:ZwDeleteAtom
* TESTS
* tests/atom.c
* SEARCH
@@ -587,6 +582,9 @@ NTSTATUS WINAPI NtDeleteAtom(
/******************************************************************
* NtFindAtom (NTDLL.@)
+ * ZwFindAtom (NTDLL.@)
+ * NtFindAtom (NTOSKRNL.@)
+ *
* Find the atom handle associated with a name in the global atom table.
* RETURNS
*| Type NTSTATUS.
@@ -594,9 +592,6 @@ NTSTATUS WINAPI NtDeleteAtom(
*| STATUS_INVALID_PARAMETER if 'name' is too long, 'atom' is null or
*| the number is too big.
*| Other status values from the Wine server.
- * FORWARDS
- *| From ntoskrnl.exe:NtFindAtom
- *| From ntdll:ZwFindAtom
* TESTS
* tests/atom.c
* DEFECTS
@@ -635,6 +630,9 @@ NTSTATUS WINAPI NtFindAtom(
/******************************************************************
* NtQueryInformationAtom (NTDLL.@)
+ * ZwQueryInformationAtom (NTDLL.@)
+ * NtQueryInformationAtom (NTOSKRNL.@)
+ *
* Get information about atoms in the global information table or global
* atom table information.
* RETURNS
@@ -659,9 +657,6 @@ NTSTATUS WINAPI NtFindAtom(
*| ULONG NumberOfAtoms; RTL_ATOM Atoms[1];
*| } ATOM_TABLE_INFORMATION, *PATOM_TABLE_INFORMATION;
*|
- * FORWARDS
- *| From ntoskrnl.exe:NtQueryInformationAtom
- *| From ntdll:ZwQueryInformationAtom
* TESTS
* tests/atom.c
* DEFECTS
--
1.7.4
More information about the wine-patches
mailing list