doc: clean up docs

librashader-capi/Cargo.toml

@@ -24,7 +24,7 @@ runtime-vulkan = ["ash", "librashader/vk"]
 docsrs = []
 
 [dependencies]
-librashader = { path = "../librashader", version = "0.1.0-beta.7" }
+librashader = { path = "../librashader", version = "0.1.0-beta.7", features = ["internal"] }
 thiserror = "1.0.37"
 paste = "1.0.9"
 gl = { version = "0.14.0", optional = true }

librashader-preprocess/src/lib.rs

@@ -1,4 +1,13 @@
-//! Shader preprocessing for librashader
+//! Shader preprocessing for librashader.
+//!
+//! This crate contains facilities and types for resolving `#include` directives in `.slang`
+//! into a single compilation unit. `#pragma` directives are also parsed and resolved as
+//! [`ShaderParameter`](crate::ShaderParameter) structs.
+//!
+//! The resulting [`ShaderSource`](crate::ShaderSource) can then be passed into a
+//! reflection target for reflection and compilation into the target shader format.
+//!
+//! Re-exported as [`librashader::preprocess`](https://docs.rs/librashader/latest/librashader/preprocess/index.html).
 mod error;
 mod include;
 mod pragma;

librashader-presets/src/lib.rs

@@ -1,4 +1,12 @@
-//! Shader preset definition (`.slangp`) parser for librashader.
+//! Shader preset definition parsing for librashader.
+//!
+//! This crate contains facilities and types for parsing `.slangp` shader presets files.
+//!
+//! Shader presets contain shader and texture parameters, and the order in which to apply a set of
+//! shaders in a filter chain. A librashader runtime takes a resulting [`ShaderPreset`](crate::ShaderPreset)
+//! as input to create a filter chain.
+//!
+//! Re-exported as [`librashader::presets`](https://docs.rs/librashader/latest/librashader/presets/index.html).
 #![feature(drain_filter)]
 
 mod error;

librashader/Cargo.toml

@@ -41,3 +41,4 @@ runtime = []
 reflect = []
 preprocess = []
 presets = []
+internal = []

librashader/src/lib.rs

@@ -1,4 +1,5 @@
 #![forbid(missing_docs)]
+#![feature(doc_cfg)]
 //! RetroArch shader preset compiler and runtime.
 //!
 //! librashader provides convenient and safe access to RetroArch ['slang' shaders](https://github.com/libretro/slang-shaders).
@@ -33,10 +34,14 @@
 //! or [`librashader.h`](https://github.com/SnowflakePowered/librashader/blob/master/include/librashader.h).
 
 #[cfg(feature = "presets")]
+#[doc(cfg(presets))]
 /// Parsing and usage of shader presets.
 ///
-/// Shader presets contain shader and texture parameters, and the order in which to apply a set of shaders
+/// This module contains facilities and types for parsing `.slangp` shader presets files.
-/// in a filter chain.
+///
+/// Shader presets contain shader and texture parameters, and the order in which to apply a set of
+/// shaders in a filter chain. A librashader runtime takes a resulting [`ShaderPreset`](crate::presets::ShaderPreset)
+/// as input to create a filter chain.
 pub mod presets {
     use librashader_preprocess::{PreprocessError, ShaderParameter, ShaderSource};
     pub use librashader_presets::*;
@@ -56,15 +61,21 @@ pub mod presets {
 }
 
 #[cfg(feature = "preprocess")]
+#[doc(cfg(preprocess))]
 /// Loading and preprocessing of 'slang' shader source files.
 ///
-/// Shader sources files must be loaded with imports resolved before being able to be compiled.
+/// This module contains facilities and types for resolving `#include` directives in `.slang`
-/// Shader parameters are also defined in `#pragma`s within shader source files which must be parsed.
+/// into a single compilation unit. `#pragma` directives are also parsed and resolved as
+/// [`ShaderParameter`](crate::preprocess::ShaderParameter) structs.
+///
+/// The resulting [`ShaderSource`](crate::preprocess::ShaderSource) can then be passed into a
+/// reflection target for reflection and compilation into the target shader format.
 pub mod preprocess {
     pub use librashader_preprocess::*;
 }
 
 #[cfg(feature = "reflect")]
+#[doc(cfg(reflect))]
 /// Shader compilation and reflection.
 pub mod reflect {
     /// Supported shader compiler targets.
@@ -106,13 +117,17 @@ pub mod reflect {
 
 /// Shader runtimes to execute a filter chain on a GPU surface.
 #[cfg(feature = "runtime")]
+#[doc(cfg(runtime))]
 pub mod runtime {
     pub use librashader_common::{Size, Viewport};
     pub use librashader_runtime::parameters::FilterChainParameters;
 
     #[cfg(feature = "gl")]
+    #[doc(cfg(gl))]
     /// Shader runtime for OpenGL 3.3+.
     ///
+    /// DSA support requires OpenGL 4.6.
+    ///
     /// Note that the OpenGL runtime requires `gl` to be
     /// initialized with [`gl::load_with`](https://docs.rs/gl/0.14.0/gl/fn.load_with.html).
     pub mod gl {
@@ -123,6 +138,7 @@ pub mod runtime {
         };
 
         #[doc(hidden)]
+        #[cfg(feature = "internal")]
         /// Re-exports names to deal with C API conflicts.
         ///
         /// This is internal to librashader-capi and is exempt from semantic versioning.
@@ -132,6 +148,7 @@ pub mod runtime {
     }
 
     #[cfg(feature = "d3d11")]
+    #[doc(cfg(d3d11))]
     /// Shader runtime for Direct3D 11.
     pub mod d3d11 {
         pub use librashader_runtime_d3d11::{
@@ -143,6 +160,7 @@ pub mod runtime {
         };
 
         #[doc(hidden)]
+        #[cfg(feature = "internal")]
         /// Re-exports names to deal with C API conflicts.
         ///
         /// This is internal to librashader-capi and is exempt from semantic versioning.
@@ -152,6 +170,7 @@ pub mod runtime {
     }
 
     #[cfg(feature = "vk")]
+    #[doc(cfg(vk))]
     /// Shader runtime for Vulkan 1.3+.
     pub mod vk {
         pub use librashader_runtime_vk::{
@@ -163,6 +182,7 @@ pub mod runtime {
         };
 
         #[doc(hidden)]
+        #[cfg(feature = "internal")]
         /// Re-exports names to deal with C API conflicts.
         ///
         /// This is internal to librashader-capi and is exempt from semantic versioning.
@@ -172,6 +192,7 @@ pub mod runtime {
     }
 
     #[doc(hidden)]
+    #[cfg(feature = "internal")]
     /// Helper methods for runtimes.
     ///
     /// This is internal to librashader runtimes and is exempt from semantic versioning.