Class: oops_live_docs

Source Location: /modules/module_oops.php

Class oops_live_docs

Class Overview

Live documentation

Located in /modules/module_oops.php [line 6197]

Properties

$instance

Methods

[ Top ]

Property Summary

static mixed

$instance

[ Top ]

Method Summary

static void	instance()
void	build_column_docs()
void	build_documentation()	Build the actual documentation
void	build_record_docs()
void	build_smartymodifier_docs()
void	build_smarty_docs()
void	extract_text_from_doccomment()
void	find_files_to_scan()	Determine which files to scan for livedocs
void	generate_text_from_doccomment()
void	get_anchorsafe_title()
void	is_useful_doccomment()
void	output()
void	search_classes()	Returns classes that are inherited from oops_record or start with 'oops_'

[ Top ]

Properties

static mixed $instance = false [line 6200]

API Tags:

Access:

protected

[ Top ]

Methods

static method instance [line 6202]

static void instance(
)

API Tags:

Access:

public

[ Top ]

build_column_docs [line 6325]

void build_column_docs(

$refclass, 
$column 
)

Parameters:

	$refclass:
	$column:

API Tags:

Access:

protected

[ Top ]

build_documentation [line 6425]

void build_documentation(
)

Build the actual documentation

API Tags:

Access:

protected

[ Top ]

build_record_docs [line 6359]

void build_record_docs(

$refclass, 
$refmethod 
)

Parameters:

	$refclass:
	$refmethod:

API Tags:

Access:

protected

[ Top ]

build_smartymodifier_docs [line 6406]

void build_smartymodifier_docs(

$refclass, 
$refmethod 
)

Parameters:

	$refclass:
	$refmethod:

API Tags:

Access:

protected

[ Top ]

build_smarty_docs [line 6396]

void build_smarty_docs(

$refclass, 
$refmethod 
)

Parameters:

	$refclass:
	$refmethod:

API Tags:

Access:

protected

[ Top ]

extract_text_from_doccomment [line 6256]

void extract_text_from_doccomment(

$doccomment 
)

Parameters:

$doccomment:

API Tags:

Access:

protected

[ Top ]

find_files_to_scan [line 6235]

void find_files_to_scan(
[
$classes = false] 
)

Determine which files to scan for livedocs

Parameters:

$classes:

API Tags:

Access:

protected

[ Top ]

generate_text_from_doccomment [line 6271]

void generate_text_from_doccomment(

$doccomment 
)

Parameters:

$doccomment:

API Tags:

Access:

protected

[ Top ]

get_anchorsafe_title [line 6416]

void get_anchorsafe_title(

$title 
)

Parameters:

$title:

API Tags:

Access:

protected

[ Top ]

is_useful_doccomment [line 6303]

void is_useful_doccomment(

$doccomment 
)

Parameters:

$doccomment:

API Tags:

Access:

protected

[ Top ]

output [line 6560]

void output(
)

API Tags:

Access:

public

[ Top ]

search_classes [line 6213]

void search_classes(
)

Returns classes that are inherited from oops_record or start with 'oops_'

API Tags:

Access:

protected

[ Top ]

Documentation generated on Thu, 17 May 2012 01:07:20 +0200 by phpDocumentor 1.4.3

	pivotx

[ class tree: pivotx ] [ index: pivotx ] [ all elements ]