Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kallazz committed Oct 8, 2023
1 parent 504f835 commit f9890be
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
4 changes: 4 additions & 0 deletions src/build_data.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ impl BuildData {
Ok(files)
}

/// Get Java source files (.java) from the `source_files` collection.
pub fn get_java_source_files(&self) -> StringVector {
let mut java_source_files = StringVector::new();

Expand All @@ -120,6 +121,7 @@ impl BuildData {
java_source_files
}

/// Get Java compiled files (.class) from the `compiled_files` collection.
pub fn get_java_compiled_files(&self) -> StringVector {
let mut java_compiled_files = StringVector::new();

Expand All @@ -132,6 +134,7 @@ impl BuildData {
java_compiled_files
}

/// Get C/C++ source files (.c, .cpp) from the `source_files` collection.
pub fn get_cpp_source_files(&self) -> StringVector {
let mut cpp_source_files = StringVector::new();

Expand All @@ -145,6 +148,7 @@ impl BuildData {
cpp_source_files
}

/// Get C/C++ compiled files (.o) from the `compiled_files` collection.
pub fn get_cpp_compiled_files(&self) -> StringVector {
let mut cpp_compiled_files = StringVector::new();

Expand Down
6 changes: 5 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
//! MakeWiz is a command line tool that generates a Makefile based on the files in your directory.
//!
//! Makefiles can be generated for C, C++ and Java.
//! Run `makewiz` to generate a Makefile for your C/C++ project.
//!
//! Run `makewiz java` to generate a Makefile for your Java project.
//!
//! For a more detailed usage guide and installation guide, visit [MakeWiz's GitHub page](https://github.com/kallazz/MakeWiz).

pub mod cli;
pub mod build_data;
Expand Down
2 changes: 1 addition & 1 deletion src/user_config.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Manages the user configuration for MakeWiz.
//! Manages the user config file.
//!
//! The user config file, stored in TOML format, holds default values for the C/C++ compiler
//! and executable name. Users can set these values to avoid specifying them every time they
Expand Down

0 comments on commit f9890be

Please sign in to comment.