Function build_function_snippet

src/completion/phpdoc/generation.rs:1314–1433

(
    sym: &SymbolInfo,
    _indent: &str,
    content: &str,
    position: Position,
    use_map: &HashMap<String, String>,
    file_namespace: &Option<String>,
    local_classes: &[Arc<ClassInfo>],

/// Parameter names within the `@param` block are space-aligned.
#[allow(clippy::too_many_arguments)]
fn build_function_snippet(
    sym: &SymbolInfo,
    _indent: &str,
    content: &str,
    position: Position,
    use_map: &HashMap<String, String>,
    file_namespace: &Option<String>,
    local_classes: &[Arc<ClassInfo>],
    class_loader: &dyn Fn(&str) -> Option<Arc<ClassInfo>>,
    function_loader: FunctionLoader<'_>,
) -> String {
    let throws_ctx = ThrowsContext {
        class_loader,
        function_loader,
        use_map,
        file_namespace,
    };
    let uncaught = throws_analysis::find_uncaught_throw_types_with_context(
        content,
        position,
        Some(&throws_ctx),
    );

    let mut tab_stop = 1u32;

    // Collect @param tags that need enrichment.
    // Each entry is (snippet_type, display_len, escaped_name).
    let mut param_tags: Vec<(String, usize, String)> = Vec::new();
    for (type_hint, name) in &sym.params {
        if let Some(enriched) = enrichment_snippet(type_hint.as_ref(), &mut tab_stop, class_loader)
        {
            // Use the plain-text version to measure the rendered width for
            // alignment.  The snippet version contains `${N:...}` markers
            // that inflate its length.
            let display_len = enrichment_plain(type_hint.as_ref(), class_loader)
                .map(|p| p.len())
                .unwrap_or(enriched.len());
            // Escape `$` in PHP parameter names so the snippet parser
            // does not treat them as snippet variables.
            param_tags.push((enriched, display_len, name.replace('$', "\\$")));
        }
    }

    // Determine @return enrichment.
    // Constructors never get @return (they implicitly return the class).
    let is_constructor = sym
        .method_name
        .as_ref()
        .is_some_and(|n| n.eq_ignore_ascii_case("__construct"));
    let is_void = sym.return_type.as_ref().is_some_and(|r| r.is_void());
    let return_tag = if is_void || is_constructor {
        None
    } else {
        // Try body-based inference first (produces richer types like
        // `list<string>` instead of `array<mixed>`).
        let body_inferred = crate::code_actions::phpstan::fix_return_type::enrichment_return_type(
            content,
            position,