[rtems commit] console_private.h: Improve comment for vt_ioctl()

[Joel Sherrill]

Module:    rtems
Branch:    master
Commit:    0ac1538db841e7bb50525720469229bd6089dfea
Changeset: http://git.rtems.org/rtems/commit/?id=0ac1538db841e7bb50525720469229bd6089dfea

Author:    Joel Sherrill <joel at rtems.org>
Date:      Fri Mar  4 13:21:02 2016 -0600

console_private.h: Improve comment for vt_ioctl()

---

 c/src/lib/libbsp/shared/console_private.h | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/c/src/lib/libbsp/shared/console_private.h b/c/src/lib/libbsp/shared/console_private.h
index 2af5326..42a8ee9 100644
--- a/c/src/lib/libbsp/shared/console_private.h
+++ b/c/src/lib/libbsp/shared/console_private.h
@@ -31,11 +31,14 @@ extern rtems_device_minor_number  BSPPrintkPort;
 /**
  *  @brief
  *
- *  This function
+ *  This function is the ioctl() support for a VGA buffer driver.
  *
- *  @return This method returns
+ *  @return This method returns 0 on success.
  */
-int vt_ioctl( unsigned int cmd, unsigned long arg);
+int vt_ioctl(
+  unsigned int cmd,
+  unsigned long arg
+);
 
 /**
  *  @brief console_initialize_data