Update documentation and comments.

Author: darrell-roberts

cli/src/args.rs

@@ -150,6 +150,7 @@ pub(crate) fn build_command() -> Command<'static> {
                 .min_values(1),
         ).arg(
             Arg::new(ARG_TARGET_OS)
+                .short('t')
                 .long("target-os")
                 .help("Optional restrict to target_os")
                 .takes_value(true)

core/src/target_os_check.rs

@@ -5,18 +5,22 @@ use quote::ToTokens;
 use syn::{punctuated::Punctuated, Attribute, Expr, ExprLit, Lit, Meta, Token};
 
 #[derive(Copy, Clone, Default, Debug)]
+/// Scoped inside a block that either accepts
+/// or rejects.
 enum TargetScope {
     #[default]
     Accept,
     Reject,
 }
 
 #[derive(Default)]
+/// An iterator that yeilds all meta items and their contained scope.
 struct TargetOsIterator {
     meta: Vec<(TargetScope, Meta)>,
 }
 
 impl TargetOsIterator {
+    /// Create a new nested meta iterator.
     fn new(meta: Meta) -> Self {
         Self {
             meta: Vec::from([(TargetScope::Accept, meta)]),

docs/src/usage/configuration.md

@@ -7,16 +7,22 @@ The behaviour of Typeshare can be customized by either passing options on the co
 - `-l`, `--lang`
     (Required) The language you want your definitions to be generated in. Currently, this option can be set to either `kotlin`, `swift`, `go`, or `typescript`.
 - `-o`, `--output-file`
-    (Required) The file path to which the generated definitions will be written.
+    (Required or -d) The file path to which the generated definitions will be written.
+- `-d`, `--directory`
+    (Required or -o) The folder path to write the multiple module files to.
 
 - `-s`, `--swift-prefix`
-    Specify a prefix that will be prepended to type names when generating types in Swift. 
+    Specify a prefix that will be prepended to type names when generating types in Swift.
 
 - `-M`, `--module-name`
-    Specify the name of the Kotlin module for generated Kotlin source code. 
+    Specify the name of the Kotlin module for generated Kotlin source code.
+
+- `-t`, `--target-os`
+    Optional comma separated list of target os targets. Types that are restricted via `#[cfg(target_os = <target>]`
+    that do not match the argument list will be filtered out.
 
 - `-j`, `--java-package`
-    Specify the name of the Java package for generated Kotlin types. 
+    Specify the name of the Java package for generated Kotlin types.
 
 - `-c`, `--config-file`
     Instead of searching for a `typeshare.toml` file, this option can be set to specify the path to the configuration file that Typeshare will use.
@@ -54,4 +60,4 @@ In the configuration file, you can specify the options you want to set so that t
 In order to create a config file you can run the following command to generate one in your current directory.
 ```
 typeshare -g
-```
+```