RUSTDOC-STRIPPER(1)

📦
version 0.1.19 · 5 versions
, in ubuntu resolute, ubuntu stonking

💖 NAME 💖

okay so bestie, say hi to rustdoc-stripper — and like, that's it, that's the whole description. The name is rustdoc-stripper and it does rustdoc-stripper things. no cap, the manpage really said "same word twice" and honestly? iconic. 💅

✨ DESCRIPTION ✨

So rustdoc-stripper is your lil doc-comment goblin 🧚 — it can yank your doc comments out of your source files and stash them somewhere safe, and then put them back when you need them. Obsessed.

Here's everything it can do, no details skipped, fr fr:

🎀 Available options for rustdoc-stripper

  • -h, --help — Displays this help. baby's first flag 🍼 ask and it shall answer.
  • -s, --strip — Strips the specified folder's files and creates a file with doc comments (comments.md by default). Your comments get ✨yeeted✨ into a new home.
  • -g, --regenerate — Recreates files with doc comments by reading the doc comments file (comments.md by default). the comeback tour 💫
  • -n, --no-file-output — Displays doc comments directly on stdout. no files, no clutter, just vibes on your terminal 🌈
  • -i, --ignore [filename] — Ignore the specified file. You can repeat this as much as you need! 🫶 Heads up though: it's only used when stripping files, and it's ignored otherwise.
  • -d, --dir [directory] — Specify a directory path to work on. Optional, so like, use it if you want 💁‍♀️
  • -v, --verbose — Activates verbose mode. she talks more now 🗣️
  • -f, --force — Removes confirmation demands. no more "are you sure??" — it just goes 🔥
  • -m, --ignore-macros — Macros in the hierarchy will be ignored (so only macros with doc comments will appear in the comments file). keeping it selective, we love a curated feed 💜
  • -o, --comment-file — Specify the file where you want to save/load doc comments. pick your own ✨special spot✨ instead of the default.
  • -x, --ignore-doc-commented — When regenerating doc comments, if doc comments are already present, the stored doc comment won't be regenerated. she respects what's already there 🎀

🌸 the defaults, babes

By default, rustdoc-stripper is run with the -s option:

./rustdoc-stripper -s
IMPORTANT: Only files ending with .rs will be stripped/regenerated. 🚨 like literally only the .rs girlies get touched, don't come for her about anything else.

sign-off, mwah 💋 — this whole page is for rustdoc-stripper version 0.1.19, dated September 2025. go forth and strip responsibly, bestie 🦋✨👑

📦 where this page comes from