.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Clang::Index 3pm" .TH Clang::Index 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Clang::Index \- Clang index class .SH VERSION .IX Header "VERSION" version 0.09 .SH DESCRIPTION .IX Header "DESCRIPTION" A \f(CW\*(C`Clang::Index\*(C'\fR represents a set of translation units that would typically be linked together into an executable or library. .SH METHODS .IX Header "METHODS" .ie n .SS "new( $exclude_declarations )" .el .SS "new( \f(CW$exclude_declarations\fP )" .IX Subsection "new( $exclude_declarations )" Create a new \f(CW\*(C`Clang::Index\*(C'\fR object. .ie n .SS "parse( $filename )" .el .SS "parse( \f(CW$filename\fP )" .IX Subsection "parse( $filename )" Parse the file \f(CW$filename\fR and retrieve the corresponding Clang::TUnit. .SH AUTHOR .IX Header "AUTHOR" Alessandro Ghedini .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright 2012 Alessandro Ghedini. .PP This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License. .PP See http://dev.perl.org/licenses/ for more information.