Crate todl

Source
Expand description

Todl allows for searching and working with comment tags. Comment tags are comments left in code or macros that use a pattern to categorize their purpose. See https://en.wikipedia.org/wiki/Comment_(computer_programming)#Tags for more information.

In this example there is a TODO comment tag and a rust todo! macro.

// TODO: Add cool features
fn foo() {
    todo!("This is where the cool features should be")
}

§Basic usage

To use todl as a library

use todl::{search_files, SearchOptions};

for tag in search_files(".", SearchOptions::default()) {
    println!("{}", tag);
}

Re-exports§

pub use source::SourceFile;
pub use source::SourceKind;
pub use tag::Tag;
pub use tag::TagKind;
pub use tag::TagLevel;

Modules§

source
Identify and search source files
tag
Progromatic representations of comment tags and similar macros

Structs§

SearchOptions
Options passed to search_files

Functions§

search_files
Recursively search for tags in files.