Commit d880f0e2 by Jim Stichnoth

Subzero: Doxygenify TODO comments.

Uses a nasty regexp to turn something like: // ... TODO(stichnot): Fix // this. into: /// ... @todo TODO(stichnot): Fix /// this. so that doxygen can generate the TODO list. Matches "TODO:" and "TODO " and "TODO(...". BUG= none R=rkotlerimgtec@gmail.com Review URL: https://codereview.chromium.org/1489413007 .
parent 52b51571
...@@ -848,7 +848,16 @@ IMAGE_PATH = ...@@ -848,7 +848,16 @@ IMAGE_PATH =
# code is scanned, but not when the output code is generated. If lines are added # code is scanned, but not when the output code is generated. If lines are added
# or removed, the anchors will not be placed correctly. # or removed, the anchors will not be placed correctly.
INPUT_FILTER = # This script transforms TODO strings into a @todo form. It also transforms
# "//" into "///" (but only when there are exactly 2 '/' characters in a row).
# The first pattern matches "//" at the beginning of the line, and the second
# pattern matches a mid-line "//". The third pattern matches "TODO " or
# "TODO(owner)" or "TODO:". This should cover the usual TODO patterns, while
# not falsely matching e.g. a call to a function whose name ends in "TODO".
INPUT_FILTER = "sed -e 's?^//\([^/]\)?///\1?' \
-e 's?\([^/]\)//\([^/]\)?\1///\2?' \
-e 's/ \(TODO[ (:]\)/ @todo \1/g'"
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the # basis. Doxygen will compare the file name with each pattern and apply the
......
...@@ -45,9 +45,8 @@ ...@@ -45,9 +45,8 @@
/// Write a value into the static thread_local field. Must be done within the /// Write a value into the static thread_local field. Must be done within the
/// context of its class. /// context of its class.
/// \todo TODO(stichnot) /// TODO(stichnot): Limit this define to only the platforms that absolutely
/// Limit this define to only the platforms that absolutely require it. And /// require it. And ideally, eventually remove this hack altogether.
/// ideally, eventually remove this hack altogether.
/// ///
/// ///
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment