Skip to content

Given --internal on the CLI, internal source items no longer appears in documentation #29

@sam-falvo

Description

@sam-falvo

As of commit 7b24ca1, it appears that features marked internal are never included in the output, even if I provide the --internal flag on the command-line.

For example, let's suppose I have a file gui.c that includes the following:

/*****if* gui/_on_screen_draw
 *
 * NAME
 *   _on_screen_draw
 *
 * SYNOPSIS
 */

static gboolean
_on_screen_draw(GtkWidget* widget, cairo_t* cr, gpointer data)

/*
 * FUNCTION
 *   Redraw the Kestrel 2's MGIA (or, in later models, CGIA) video output.
 *
 * INPUTS
 *   widget -- set by GTK to the GtkDrawingArea containing the video output.
 *   cr -- set by GTK to the Cairo drawing context.
 *   data -- A gpointer back to the gui_t for the application.
 *
 * RESULT
 *
 * SEE ALSO
 *   gui_init
 *
 * SOURCE
 */
{
	// Get our own widget dimensions

	gui_t* gui = (gui_t*)data;
	gint width = gtk_widget_get_allocated_width(widget);
	gint height = gtk_widget_get_allocated_height(widget);

// ... etc etc ...

	return FALSE;
}
/******/

If I invoke ROBOdoc with robodoc --src . --doc autodoc --internal --multidoc --html --toc , the definition for _on_screen_draw never makes it into the generated documentation.

Thinking that maybe it might appear if I additionally provide --index, I have confirmed that it does not get listed there either.

I am using Pop_OS! Linux (Linux pop-os 6.12.10-76061203-generic #202412060638~1753385872~22.04~dc2e00d SMP PREEMPT_DYNAMIC Thu J x86_64 x86_64 x86_64 GNU/Linux) if this is in any way helpful.

NOTE: This is not a deal breaker for me; if this issue doesn't get particularly high priority, I might (time permitting!) make an attempt at debugging this issue myself. But I just wanted to report it so that there's a record of it. Thanks for taking the time to look at this! It's much appreciated.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions