Merge "Fix <android/trace.h> doxygen formatting." am: f8844c97ee am: 1a3e35fba2
am: 908b70ed4c
Change-Id: Id67eb36ee58e0fdb2829fd9ef65f39d34ec0cdbb
diff --git a/include/android/trace.h b/include/android/trace.h
index eb7b259..aa24995 100644
--- a/include/android/trace.h
+++ b/include/android/trace.h
@@ -42,7 +42,7 @@
#if __ANDROID_API__ >= 23
/**
- * Returns true if tracing is enabled. Use this signal to avoid expensive computation only necessary
+ * Returns true if tracing is enabled. Use this to avoid expensive computation only necessary
* when tracing is enabled.
*
* Available since API level 23.
@@ -51,10 +51,10 @@
/**
* Writes a tracing message to indicate that the given section of code has begun. This call must be
- * followed by a corresponding call to endSection() on the same thread.
+ * followed by a corresponding call to {@link ATrace_endSection} on the same thread.
*
- * Note: At this time the vertical bar character '|' and newline character '\n' are used internally
- * by the tracing mechanism. If sectionName contains these characters they will be replaced with a
+ * Note: At this time the vertical bar character '|' and newline character '\\n' are used internally
+ * by the tracing mechanism. If \p sectionName contains these characters they will be replaced with a
* space character in the trace.
*
* Available since API level 23.
@@ -63,9 +63,9 @@
/**
* Writes a tracing message to indicate that a given section of code has ended. This call must be
- * preceeded by a corresponding call to beginSection(char*) on the same thread. Calling this method
+ * preceeded by a corresponding call to {@link ATrace_beginSection} on the same thread. Calling this method
* will mark the end of the most recently begun section of code, so care must be taken to ensure
- * that beginSection / endSection pairs are properly nested and called from the same thread.
+ * that {@link ATrace_beginSection}/{@link ATrace_endSection} pairs are properly nested and called from the same thread.
*
* Available since API level 23.
*/