docs: Update function documentation to use block comments

Co-authored-by: aider (openai/andrew/openrouter/sonoma-sky-alpha) <aider@aider.chat>
This commit is contained in:
Andrew Phillips
2025-09-10 16:53:50 -03:00
parent ec95bc8028
commit 94e82e132a
2 changed files with 67 additions and 64 deletions

View File

@@ -60,17 +60,17 @@ use crate::common::status::{MetaPluginInfo, CompressionInfo};
fn build_meta_plugin_table(meta_plugin_info: &std::collections::HashMap<String, MetaPluginInfo>) -> Table {
/// Builds a formatted table displaying meta plugin information.
///
/// Sorts plugins by name and displays options as YAML and outputs as a list.
///
/// # Arguments
///
/// * `meta_plugin_info` - HashMap of meta plugin information.
///
/// # Returns
///
/// A formatted `comfy_table::Table`.
// Builds a formatted table displaying meta plugin information.
//
// Sorts plugins by name and displays options as YAML and outputs as a list.
//
// # Arguments
//
// * `meta_plugin_info` - HashMap of meta plugin information.
//
// # Returns
//
// A formatted `comfy_table::Table`.
let mut meta_plugin_table = crate::modes::common::create_table(true);
meta_plugin_table.set_header(vec![
@@ -291,20 +291,20 @@ pub fn mode_status_plugins(
data_path: PathBuf,
db_path: PathBuf,
) -> Result<(), anyhow::Error> {
/// Displays status information for available plugins in the specified output format.
///
/// Generates status using StatusService and renders as table, JSON, or YAML.
///
/// # Arguments
///
/// * `cmd` - Mutable Clap command.
/// * `settings` - Application settings.
/// * `data_path` - Data directory path.
/// * `db_path` - Database path.
///
/// # Returns
///
/// `Ok(())` on success, or anyhow::Error.
// Displays status information for available plugins in the specified output format.
//
// Generates status using StatusService and renders as table, JSON, or YAML.
//
// # Arguments
//
// * `cmd` - Mutable Clap command.
// * `settings` - Application settings.
// * `data_path` - Data directory path.
// * `db_path` - Database path.
//
// # Returns
//
// `Ok(())` on success, or anyhow::Error.
debug!("STATUS_PLUGINS: Starting mode_status_plugins function");
let status_service = crate::services::status_service::StatusService::new();