Merge "Fixed documentation generation for .inc files"

wpilibc/cpp.doxy

@@ -216,7 +216,7 @@ SEPARATE_MEMBER_PAGES  = NO
 # uses this value to replace tabs by spaces in code fragments.
 # Minimum value: 1, maximum value: 16, default value: 4.
 
-TAB_SIZE               = 4
+TAB_SIZE               = 2
 
 # This tag can be used to specify a number of aliases that act as commands in
 # the documentation. An alias has the form:
@@ -281,7 +281,7 @@ OPTIMIZE_OUTPUT_VHDL   = NO
 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
 # the files are not read by doxygen.
 
-EXTENSION_MAPPING      =
+EXTENSION_MAPPING      = inc=C++
 
 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
 # according to the Markdown format, which allows for more readable

wpilibc/wpilibC++/include/Task.inc

@@ -3,11 +3,10 @@
 
 /**
  * Create and launch a task.
+ *
  * @param name The name of the task. "FRC_" will be prepended to the task name.
  * @param function The address of the function to run as the new task.
  * @param args A parameter pack of arguments to pass to the function.
- * @param priority The VxWorks priority for the task.
- * @param stackSize The size of the stack for the task
  */
 template <class Function, class... Args>
 Task::Task(const std::string& name, Function&& function, Args&&... args) {

wpilibc/wpilibC++Devices/src/Task.cpp

@@ -57,7 +57,8 @@ std::thread::native_handle_type Task::native_handle() {
 
 /**
  * Verifies a task still exists.
- * @returns true on success.
+ *
+ * @return true on success.
  */
 bool Task::Verify() {
   TASK id = (TASK)m_thread.native_handle();
@@ -66,7 +67,8 @@ bool Task::Verify() {
 
 /**
  * Gets the priority of a task.
- * @returns task priority or 0 if an error occured
+ *
+ * @return task priority or 0 if an error occured
  */
 int32_t Task::GetPriority() {
   int priority;
@@ -81,8 +83,9 @@ int32_t Task::GetPriority() {
  * This routine changes a task's priority to a specified priority.
  * Priorities range from 1, the lowest priority, to 99, the highest priority.
  * Default task priority is 60.
+ *
  * @param priority The priority at which the internal thread should run.
- * @returns true on success.
+ * @return true on success.
  */
 bool Task::SetPriority(int32_t priority) {
   auto id = m_thread.native_handle();
@@ -91,7 +94,8 @@ bool Task::SetPriority(int32_t priority) {
 
 /**
  * Returns the name of the task.
- * @returns The name of the task (0 length if not allocated).
+ *
+ * @return The name of the task.
  */
 std::string Task::GetName() const { return m_taskName; }