Skip to content

Commit

Permalink
chore(doc): add top-level doc comments to published crates
Browse files Browse the repository at this point in the history
  • Loading branch information
wravery committed Feb 7, 2025
1 parent 5ff00fa commit 2ab930b
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cef/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! # cef-rs
//! # cef
//!
//! Use the [Chromium Embedded Framework](https://github.com/chromiumembedded/cef) in Rust.
Expand Down
2 changes: 1 addition & 1 deletion download-cef/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "download-cef"
description = "Download and extract pre-built CEF (Chromium Embedded Framework) archives."
version = "1.2.0"
version = "1.2.1"

edition.workspace = true
license.workspace = true
Expand Down
5 changes: 5 additions & 0 deletions download-cef/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
//! # download-cef
//!
//! Utility functions to download and extract prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
//! archives on any supported platform.
use bzip2::bufread::BzDecoder;
use serde::{Deserialize, Serialize};
use sha1_smol::Sha1;
Expand Down
23 changes: 23 additions & 0 deletions export-cef-dir/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
//! # export-cef-dir
//!
//! Export files from the prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
//! archive on any supported platform. The structure of the exported directory matches the way that
//! the `cef-dll-sys` crate expects to see them.
//!
//! To use the target directory when building, set the `CEF_PATH` environment variable to the path of the
//! exported directory, e.g., `~/.local/share/cef`.
//!
//! To use the DLLs in this directory at runtime, the library loader path varies by platform:
//! - Linux
//! ```sh
//! export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:$CEF_PATH"
//! ```
//! - macOS
//! ```sh
//! export DYLD_FALLBACK_LIBRARY_PATH="$DYLD_FALLBACK_LIBRARY_PATH:$CEF_PATH"
//! ```
//! - Windows (using PowerShell)
//! ```pwsh
//! $env:PATH = "$env:PATH;$env:CEF_PATH"
//! ```
use clap::Parser;
use download_cef::{CefIndex, OsAndArch};
use std::{
Expand Down
5 changes: 5 additions & 0 deletions sys/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
//! # cef-dll-sys
//!
//! Generated bindings for the prebuilt [Chromium Embedded Framework](https://github.com/chromiumembedded/cef)
//! C API on any supported platform.
#[allow(
non_snake_case,
non_camel_case_types,
Expand Down

0 comments on commit 2ab930b

Please sign in to comment.