diff options
| author | Aaron Ballman <aaron@aaronballman.com> | 2016-01-21 15:18:25 +0000 |
|---|---|---|
| committer | Aaron Ballman <aaron@aaronballman.com> | 2016-01-21 15:18:25 +0000 |
| commit | c35724cc7252381abd99f62513fee1de85b56b15 (patch) | |
| tree | 7e0fabf100cf1d95f791205aa4ea7c8ecaf28cac /clang/docs/tools | |
| parent | 2455701117c12d1fae811cc148a951984351e444 (diff) | |
| download | bcm5719-llvm-c35724cc7252381abd99f62513fee1de85b56b15.tar.gz bcm5719-llvm-c35724cc7252381abd99f62513fee1de85b56b15.zip | |
When dumping documentation for AST matchers, do something more useful with \see doxygen commands. Ideally this would link to the target of \see, but for now it translates \see into "See also: "
Regenerate the AST documentation for this new functionality.
llvm-svn: 258401
Diffstat (limited to 'clang/docs/tools')
| -rw-r--r-- | clang/docs/tools/dump_ast_matchers.py | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/clang/docs/tools/dump_ast_matchers.py b/clang/docs/tools/dump_ast_matchers.py index 9ecff049c96..9c05eb888c0 100644 --- a/clang/docs/tools/dump_ast_matchers.py +++ b/clang/docs/tools/dump_ast_matchers.py @@ -83,6 +83,11 @@ def strip_doxygen(comment): """Returns the given comment without \-escaped words.""" # If there is only a doxygen keyword in the line, delete the whole line. comment = re.sub(r'^\\[^\s]+\n', r'', comment, flags=re.M) + + # If there is a doxygen \see command, change the \see prefix into "See also:". + # FIXME: it would be better to turn this into a link to the target instead. + comment = re.sub(r'\\see', r'See also:', comment) + # Delete the doxygen command and the following whitespace. comment = re.sub(r'\\[^\s]+\s+', r'', comment) return comment |
