#strip #tool #rustdoc #doc

bin+lib rustdoc-stripper

A tool to manipulate rustdoc comments

6 releases

0.1.5 Sep 14, 2017
0.1.4 Jul 10, 2017
0.1.2 Apr 8, 2016
0.1.1 Mar 31, 2016

#13 in #tool

Download history 165/week @ 2018-12-20 61/week @ 2018-12-27 99/week @ 2019-01-03 331/week @ 2019-01-10 410/week @ 2019-01-17 471/week @ 2019-01-24 563/week @ 2019-01-31 535/week @ 2019-02-07 240/week @ 2019-02-14 543/week @ 2019-02-21 183/week @ 2019-02-28 313/week @ 2019-03-07 96/week @ 2019-03-14 221/week @ 2019-03-21 23/week @ 2019-03-28

566 downloads per month
Used in 26 crates (17 directly)

Apache-2.0

67KB
1.5K SLoC

rustdoc-stripper Build Status

rustdoc-stripper is a tool used to remove rustdoc comments from your code and save them in a comments.cmts file if you want to regenerate them.

###Options

Available options for rustdoc-stripper are:

  • -h | --help : Displays this help
  • -s | --strip : Strips the current folder files and create a file with rustdoc information (comments.cmts by default)
  • -g | --regenerate : Recreate files with rustdoc comments from reading rustdoc information file (comments.cmts by default)
  • -n | --no-file-output : Display rustdoc information directly on stdout
  • -i | --ignore [filename]: Ignore the specified file, can be repeated as much as needed, only used when stripping files, ignored otherwise
  • -d | --dir [directory] : Specify a directory path to work on, optional
  • -v | --verbose : Activate verbose mode
  • -f | --force : Remove confirmation demands
  • -m | --ignore-macros : macros in hierarchy will be ignored (so only macros with doc comments will appear in the comments file)
  • -o | --comment-file : specify the file within you want to save rustdoc information

By default, rustdoc is run with -s option:

./rustdoc-stripper -s

IMPORTANT: Only files ending with '.rs' will be stripped/regenerated.

No runtime deps