gtkdoc-scan(1)

gtkdoc-scan1

Extracts declarations of functions, macros, enums, structs and unions from header files.

Usage

gtkdoc-scan [MODULE name] [source directory (optional)] [output directory (optional)] [header file]

Overview

gtkdoc-scan Extracts declarations of functions, macros, enums, structs and unions from header files.

It is called with a module name, an optional source directory, an optional output directory, and the header files to scan.

It outputs all declarations found to a file named MODULE-decl.txt, and the list of declarations to another file MODULE-decl-list.txt

This second list file is typically copied to SGML pages.

This binary must be used inside a Makefile and not directly in a command line. See section EXAMPLE.

Examples

See /usr/share/doc/gtk-doc-tools/examples, for a makefile.am and a configure.in example file.

Releases

10 releases since Debian 2.2 (Potato); the text changed 2 times.

  1. 2.2
  2. 3.0
  3. 3.1–10

Author

This manual page was written by Christian Marillat [email protected] for the Debian GNU/Linux system (but may be used by others).

From gtk-doc-tools 1.28-1 in Debian 10 (Buster). Parsed by carta from the page's man source.