Skip to content

Commit

Permalink
Extended documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ReubenHillyard committed Sep 26, 2023
1 parent 09bc62a commit 00b36ab
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/commands/main_command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ impl MainArguments {
})
}

/// Runs the compiler on the given arguments.
///
/// This is called from [`main`](crate::main).
pub fn run(self) -> Result<(), String> {
let tokens = self.lex()?;

Expand Down
1 change: 1 addition & 0 deletions src/commands/mod.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
//! Types and functions for providing the command line interface.

#[doc(hidden)]
macro_rules! verbose_println {
($args:expr, $($msg:tt),*) => {
if $args.verbose {
Expand Down
1 change: 1 addition & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ pub mod lexer;
pub mod parser;
pub mod typing;

/// Parses command line arguments and runs the compiler on them.
pub fn main() {
let args = Arguments::parse();
let args = MainArguments::new(args);
Expand Down

0 comments on commit 00b36ab

Please sign in to comment.