API Documentation
\
apex
app
db
exceptions
interfaces
msg
io
msg
objects
utils
pkg
sys
tests
utils
web
core
ajax
cli
controller
http_requests
notifications
cron
form
htmlfunc
tabcontrol
dashboard
debugger
table
worker
devkit
table
worker
digitalocean
cron
form
table
support
table
worker
transaction
controller
payment_processors
transaction
cron
exceptions
form
htmlfunc
interfaces
table
worker
users
autosuggest
form
htmlfunc
interfaces
modal
tabcontrol
manage
security
table
test
worker
tests
devkit
support
transaction
users

\apex\devkitmd_formatter

Class that handles the clearn up and nice formatting of .md documentation files, plus checks for proper syntaxes and common formatting errors.

Summary

Methods
Properties
Constants
format_file()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
format_text()
$replace_api_tags
N/A

Properties

$replace_api_tags

$replace_api_tags :

Type

Methods

format_file()

format_file(string  $filename,boolean  $replace_api_tags = false)

Format a file

Parameters

string $filename

The fll path to the file to format.
boolean $replace_api_tags

Whether or not to replace tags.

format_text()

format_text(string  $text)

Format latest text block

Parameters

string $text

The text to format.