doc: update some doc
This commit is contained in:
@@ -1,3 +1,12 @@
|
||||
# Wfassoc Core
|
||||
# WFassoc Core
|
||||
|
||||
Most Windows related struct are located in `assoc` module. The top module only contain structs exposed for convenient use of end user.
|
||||
This crate provides low level API and high level API for manipulating Windows file associations at the same time.
|
||||
For the convenient use of this project, the root module of this crate re-expose high level API.
|
||||
So programmers can directly use them.
|
||||
|
||||
High level API is type-safe and very easy to use for common application.
|
||||
For visiting high level API, please use crate root module directly or `highlevel` module.
|
||||
Oppositely, for visiting low level API, please use `lowlevel` module.
|
||||
|
||||
If you are a programmer who want to take a deep into the internal implementations,
|
||||
see `win32` module and its submodules for detail.
|
||||
|
||||
@@ -23,6 +23,10 @@ pub enum ProgramError {}
|
||||
|
||||
// endregion
|
||||
|
||||
// region: Schema
|
||||
|
||||
// region: Schema Body
|
||||
|
||||
/// Schema is the sketchpad of complete Program.
|
||||
///
|
||||
/// We will create a Schema first, fill some properties, add file extensions,
|
||||
@@ -125,6 +129,10 @@ impl Schema {
|
||||
}
|
||||
}
|
||||
|
||||
// endregion
|
||||
|
||||
// region: Schema Internals
|
||||
|
||||
/// Internal used struct as the Schema file extensions hashmap value type.
|
||||
#[derive(Debug)]
|
||||
struct SchemaExt {
|
||||
@@ -143,8 +151,18 @@ impl SchemaExt {
|
||||
}
|
||||
}
|
||||
|
||||
// endregion
|
||||
|
||||
// endregion
|
||||
|
||||
// region: Program
|
||||
|
||||
// region: Program Body
|
||||
|
||||
/// Program is a complete and immutable program representer
|
||||
pub struct Program {}
|
||||
pub struct Program {
|
||||
|
||||
}
|
||||
|
||||
impl TryFrom<Schema> for Program {
|
||||
type Error = ParseProgramError;
|
||||
@@ -159,3 +177,12 @@ impl Program {
|
||||
todo!()
|
||||
}
|
||||
}
|
||||
|
||||
// endregion
|
||||
|
||||
// region: Program Internals
|
||||
|
||||
|
||||
// endregion
|
||||
|
||||
// endregion
|
||||
|
||||
Reference in New Issue
Block a user