forked from mirrors/gstreamer-rs
Convert documentation into a proper crate
Fixes https://gitlab.freedesktop.org/gstreamer/gstreamer-rs/-/issues/258
This commit is contained in:
parent
740f668658
commit
70ee13db53
3 changed files with 103 additions and 0 deletions
|
@ -19,6 +19,7 @@ members = [
|
|||
"gstreamer-rtp",
|
||||
"examples",
|
||||
"tutorials",
|
||||
"docs",
|
||||
]
|
||||
|
||||
exclude = ["gir"]
|
||||
|
|
14
docs/Cargo.toml
Normal file
14
docs/Cargo.toml
Normal file
|
@ -0,0 +1,14 @@
|
|||
[package]
|
||||
name = "gstreamer-rs-lgpl-docs"
|
||||
version = "0.16.0"
|
||||
authors = ["Sebastian Dröge <sebastian@centricular.com>"]
|
||||
license = "LGPL-2.0"
|
||||
description = "LGPL-licensed docs for gstreamer-rs crates"
|
||||
repository = "https://gitlab.freedesktop.org/gstreamer/gstreamer-rs"
|
||||
homepage = "https://gstreamer.freedesktop.org"
|
||||
|
||||
[lib]
|
||||
name = "lgpl_docs"
|
||||
|
||||
[dependencies]
|
||||
rustdoc-stripper = "0.1.6"
|
88
docs/src/lib.rs
Normal file
88
docs/src/lib.rs
Normal file
|
@ -0,0 +1,88 @@
|
|||
extern crate stripper_lib;
|
||||
|
||||
use std::io;
|
||||
use std::path::Path;
|
||||
use stripper_lib::{loop_over_files, parse_cmts, regenerate_comments, strip_comments};
|
||||
|
||||
#[derive(Clone, Copy, Debug)]
|
||||
pub enum Library {
|
||||
GstWebRTC,
|
||||
GstVideo,
|
||||
GstSdp,
|
||||
GstRtspServer,
|
||||
GstRtsp,
|
||||
GstRtp,
|
||||
GstPlayer,
|
||||
GstNet,
|
||||
GstGL,
|
||||
GES,
|
||||
GstCheck,
|
||||
GstPbutils,
|
||||
GstBase,
|
||||
GstAudio,
|
||||
GstApp,
|
||||
Gst,
|
||||
}
|
||||
|
||||
fn docs(lib: Library) -> Option<&'static str> {
|
||||
match lib {
|
||||
Library::GstWebRTC => Some(include_str!("../gstreamer-webrtc/docs.md")),
|
||||
Library::GstVideo => Some(include_str!("../gstreamer-video/docs.md")),
|
||||
Library::GstSdp => Some(include_str!("../gstreamer-sdp/docs.md")),
|
||||
Library::GstRtspServer => Some(include_str!("../gstreamer-rtsp-server/docs.md")),
|
||||
Library::GstRtsp => Some(include_str!("../gstreamer-rtsp/docs.md")),
|
||||
Library::GstRtp => Some(include_str!("../gstreamer-rtp/docs.md")),
|
||||
Library::GstPlayer => Some(include_str!("../gstreamer-player/docs.md")),
|
||||
Library::GstNet => Some(include_str!("../gstreamer-net/docs.md")),
|
||||
Library::GstGL => Some(include_str!("../gstreamer-gl/docs.md")),
|
||||
Library::GES => Some(include_str!("../gstreamer-editing-services/docs.md")),
|
||||
Library::GstCheck => Some(include_str!("../gstreamer-check/docs.md")),
|
||||
Library::GstPbutils => Some(include_str!("../gstreamer-pbutils/docs.md")),
|
||||
Library::GstBase => Some(include_str!("../gstreamer-base/docs.md")),
|
||||
Library::GstAudio => Some(include_str!("../gstreamer-audio/docs.md")),
|
||||
Library::GstApp => Some(include_str!("../gstreamer-app/docs.md")),
|
||||
Library::Gst => Some(include_str!("../gstreamer/docs.md")),
|
||||
}
|
||||
}
|
||||
|
||||
fn vendor_docs(_lib: Library) -> Option<&'static str> {
|
||||
None
|
||||
}
|
||||
|
||||
/// Embeds the docs.
|
||||
///
|
||||
/// `path` is the root directory to process.
|
||||
///
|
||||
/// `ignores` is the list of files to skip (relative to `path`).
|
||||
pub fn embed<P: AsRef<Path>>(library: Library, path: P, ignores: &[&str]) {
|
||||
if let Some(docs) = docs(library) {
|
||||
do_embed(docs, path.as_ref(), ignores);
|
||||
}
|
||||
if let Some(docs) = vendor_docs(library) {
|
||||
do_embed(docs, path.as_ref(), ignores);
|
||||
}
|
||||
}
|
||||
|
||||
fn do_embed(docs: &str, path: &Path, ignores: &[&str]) {
|
||||
let mut infos = parse_cmts(docs.lines(), true);
|
||||
loop_over_files(
|
||||
path,
|
||||
&mut |w, s| regenerate_comments(w, s, &mut infos, true, true),
|
||||
&ignores,
|
||||
false,
|
||||
);
|
||||
}
|
||||
|
||||
/// Remove any doc comments.
|
||||
///
|
||||
/// `path` is the root directory to process.
|
||||
///
|
||||
/// `ignores` is the list of files to skip (relative to `path`).
|
||||
pub fn purge<P: AsRef<Path>>(path: P, ignores: &[&str]) {
|
||||
loop_over_files(
|
||||
path.as_ref(),
|
||||
&mut |w, s| strip_comments(w, s, &mut io::sink(), true),
|
||||
&ignores,
|
||||
false,
|
||||
);
|
||||
}
|
Loading…
Reference in a new issue