From 520d946f637ecf3f5fc9a83616d059cdb51c004b Mon Sep 17 00:00:00 2001 From: Tyler Veness Date: Sun, 1 Nov 2015 00:41:10 -0700 Subject: [PATCH] Fixed documentation generation for .inc files Change-Id: I2ba5cb335b2e29968069bd362793532de607679c --- wpilibc/cpp.doxy | 4 ++-- wpilibc/wpilibC++/include/Task.inc | 3 +-- wpilibc/wpilibC++Devices/src/Task.cpp | 12 ++++++++---- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/wpilibc/cpp.doxy b/wpilibc/cpp.doxy index d5892e012e..4157d3a070 100644 --- a/wpilibc/cpp.doxy +++ b/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 diff --git a/wpilibc/wpilibC++/include/Task.inc b/wpilibc/wpilibC++/include/Task.inc index ede71b020b..59b1dfc983 100644 --- a/wpilibc/wpilibC++/include/Task.inc +++ b/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 Task::Task(const std::string& name, Function&& function, Args&&... args) { diff --git a/wpilibc/wpilibC++Devices/src/Task.cpp b/wpilibc/wpilibC++Devices/src/Task.cpp index 043445e6ed..44f7cc9630 100644 --- a/wpilibc/wpilibC++Devices/src/Task.cpp +++ b/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; }