lsst.sconsUtils.builders.DoxygenBuilder Class Reference

A callable to be used as an SCons Action to run Doxygen. More...

Inheritance diagram for lsst.sconsUtils.builders.DoxygenBuilder:

Public Member Functions
def	__init__ (self, kw)
def	__call__ (self, env, config)
def	findSources (self)
def	findTargets (self)
def	buildConfig (self, target, source, env)

Public Attributes
	results
	sources
	targets
	useTags
	inputs
	excludes
	outputPaths
	makeTag

Detailed Description

A callable to be used as an SCons Action to run Doxygen.

This should only be used by the env.Doxygen pseudo-builder method.

Constructor & Destructor Documentation

__init__()

def lsst.sconsUtils.builders.DoxygenBuilder.__init__	(		self,
			kw
	)

Member Function Documentation

__call__()

def lsst.sconsUtils.builders.DoxygenBuilder.__call__	(		self,
			env,
			config
	)

References lsst.sconsUtils.builders.DoxygenBuilder.findSources(), lsst.sconsUtils.builders.DoxygenBuilder.findTargets(), and lsst.sconsUtils.builders.DoxygenBuilder.makeTag.

buildConfig()

def lsst.sconsUtils.builders.DoxygenBuilder.buildConfig	(		self,
			target,
			source,
			env
	)

References lsst.sconsUtils.builders.DoxygenBuilder.excludes, lsst.sconsUtils.builders.DoxygenBuilder.inputs, lsst.sconsUtils.builders.DoxygenBuilder.makeTag, lsst.sconsUtils.utils.memberOf(), lsst.sconsUtils.builders.DoxygenBuilder.outputPaths, lsst.sconsUtils.installation.DirectoryInstaller.recursive, lsst.sconsUtils.builders.DoxygenBuilder.sources, and lsst.sconsUtils.builders.DoxygenBuilder.useTags.

findSources()

def lsst.sconsUtils.builders.DoxygenBuilder.findSources

(

self

)

References lsst.sconsUtils.builders.DoxygenBuilder.excludes, lsst.sconsUtils.builders.DoxygenBuilder.inputs, lsst.sconsUtils.installation.DirectoryInstaller.recursive, and lsst.sconsUtils.builders.DoxygenBuilder.sources.

Referenced by lsst.sconsUtils.builders.DoxygenBuilder.__call__().

findTargets()

def lsst.sconsUtils.builders.DoxygenBuilder.findTargets

(

self

)

References lsst.sconsUtils.builders.DoxygenBuilder.targets.

Referenced by lsst.sconsUtils.builders.DoxygenBuilder.__call__().

Member Data Documentation

excludes

lsst.sconsUtils.builders.DoxygenBuilder.excludes

Referenced by lsst.sconsUtils.builders.DoxygenBuilder.buildConfig(), and lsst.sconsUtils.builders.DoxygenBuilder.findSources().

inputs

lsst.sconsUtils.builders.DoxygenBuilder.inputs

Referenced by lsst.sconsUtils.builders.DoxygenBuilder.buildConfig(), and lsst.sconsUtils.builders.DoxygenBuilder.findSources().

makeTag

lsst.sconsUtils.builders.DoxygenBuilder.makeTag

Referenced by lsst.sconsUtils.builders.DoxygenBuilder.__call__(), and lsst.sconsUtils.builders.DoxygenBuilder.buildConfig().

outputPaths

lsst.sconsUtils.builders.DoxygenBuilder.outputPaths

Referenced by lsst.sconsUtils.builders.DoxygenBuilder.buildConfig().

results

lsst.sconsUtils.builders.DoxygenBuilder.results

sources

lsst.sconsUtils.builders.DoxygenBuilder.sources

Referenced by lsst.sconsUtils.builders.DoxygenBuilder.buildConfig(), and lsst.sconsUtils.builders.DoxygenBuilder.findSources().

targets

lsst.sconsUtils.builders.DoxygenBuilder.targets

Referenced by lsst.sconsUtils.builders.DoxygenBuilder.findTargets().

useTags

lsst.sconsUtils.builders.DoxygenBuilder.useTags

Referenced by lsst.sconsUtils.builders.DoxygenBuilder.buildConfig().

---

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

• python/lsst/sconsUtils/builders.py