Input file to Doxygen and its comments and contents. More...

Inheritance diagram for Doxygen::Item::File:

Public Member Functions
	generate ($indent)
	Generate Doxygen comments to specify the name of the current file and any file-level comments.
	massage ($source)
	Make sure there is a brief message for the file, stealing it from a class if there is one.
	Include ()
	Add one or more 'include' file(s).
	Includes ()
	Return pointer to array reference of 'include' files.
	focus ()
	Return the focus for the file.

Detailed Description

Input file to Doxygen and its comments and contents.

SYNOPSIS

  my  $cls = new Doxygen::Item::File;

ABSTRACT

A Doxygen::Item::File object represents an imaginary C/C++ source file for processing by the Doxygen documentation system. These objects should be created by a specific source-language filter (subclass of Doxygen::Filter, named Doxygen::languageFilter) when processing a source file.

DESCRIPTION

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

Version:: '0.01'

Author:: Marc M. Adkins, mailto:Perl@Doorways.org

Definition at line 50 of file File.pm.

Member Function Documentation

Doxygen::Item::File::focus ( )

Return the focus for the file.

If there are classes, the first class is the focus. Otherwise the focus is the file itself.

Doxygen::Item::File::generate ( $ indent )

Generate Doxygen comments to specify the name of the current file and any file-level comments.

Doxygen::Item::File::Include ( )

Add one or more 'include' file(s).

Doxygen::Item::File::Includes ( )

Return pointer to array reference of 'include' files.

Doxygen::Item::File::massage ( $ source )

Make sure there is a brief message for the file, stealing it from a class if there is one.

Reimplemented from Doxygen::Item.

The documentation for this class was generated from the following file:

Item/File/File.pm

DoxyFilt: Doxygen::Item::File Class Reference

Doxygen::Item::File Class Reference