[FORMATTING]
authorAleksey Bragin <aleksey@reactos.org>
Wed, 28 Jun 2006 14:02:39 +0000 (14:02 +0000)
committerAleksey Bragin <aleksey@reactos.org>
Wed, 28 Jun 2006 14:02:39 +0000 (14:02 +0000)
- Amend file header slightly
- Add function header
- STDCALL -> NTAPI

svn path=/trunk/; revision=22673

reactos/ntoskrnl/ex/dbgctrl.c

index c60479e..bbd8580 100644 (file)
@@ -1,10 +1,9 @@
 /*
- * COPYRIGHT:       See COPYING in the top level directory
- * PROJECT:         ReactOS kernel
+ * PROJECT:         ReactOS Kernel
+ * LICENSE:         GPL - See COPYING in the top level directory
  * FILE:            ntoskrnl/ex/dbgctrl.c
  * PURPOSE:         System debug control
- *
- * PROGRAMMERS:     No programmer listed.
+ * PROGRAMMERS:     Alex Ionescu
  */
 
 /* INCLUDES *****************************************************************/
 
 /* FUNCTIONS *****************************************************************/
 
+/*++
+ * @name NtSystemDebugControl
+ * @implemented
+ *
+ * Perform various queries to debugger.
+ * This API is subject to test-case creation to further evaluate its
+ * abilities (if needed to at all)
+ *
+ * See: http://www.osronline.com/showthread.cfm?link=93915
+ *      http://void.ru/files/Ntexapi.h
+ *      http://www.codeguru.com/code/legacy/system/ntexapi.zip
+ *      http://www.securityfocus.com/bid/9694
+ *
+ * @param ControlCode
+ *        Description of the parameter. Wrapped to more lines on ~70th
+ *        column.
+ *
+ * @param InputBuffer
+ *        FILLME
+ *
+ * @param InputBufferLength
+ *        FILLME
+ *
+ * @param OutputBuffer
+ *        FILLME
+ *
+ * @param OutputBufferLength
+ *        FILLME
+ *
+  * @param ReturnLength
+ *        FILLME
+ *
+ * @return STATUS_SUCCESS in case of success, proper error code otherwise
+ *
+ * @remarks None
+ *
+ *--*/
 NTSTATUS
-STDCALL
+NTAPI
 NtSystemDebugControl(SYSDBG_COMMAND ControlCode,
                      PVOID InputBuffer,
                      ULONG InputBufferLength,