Skip to content

Commit

Permalink
modified method comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@chobie
chobie committed Jan 10, 2012
1 parent 9273baa commit 77af627
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 78 deletions.
12 changes: 7 additions & 5 deletions src/php_sundown.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ static void sundown__render(SundownRendererType render_type, INTERNAL_FUNCTION_P
}
}

/* {{{ proto string __construct(string $string [, array $extensions])
/* {{{ proto string Sundonw::__construct(string $string [, array $extensions])
setup Sundown extension */
PHP_METHOD(sundown, __construct)
{
Expand All @@ -299,7 +299,7 @@ PHP_METHOD(sundown, __construct)
}
/* }}} */

/* {{{ proto void __destruct()
/* {{{ proto void Sundonw::__destruct()
cleanup variables */
PHP_METHOD(sundown, __destruct)
{
Expand All @@ -310,23 +310,23 @@ PHP_METHOD(sundown, __destruct)
}
/* }}} */

/* {{{ proto string to_html()
/* {{{ proto string Sundonw::to_html()
Returns converted HTML string */
PHP_METHOD(sundown, to_html)
{
sundown__render(SUNDOWN_RENDER_HTML,INTERNAL_FUNCTION_PARAM_PASSTHRU);
}
/* }}} */

/* {{{ proto string __toString()
/* {{{ proto string Sundonw::__toString()
Returns converted HTML string */
PHP_METHOD(sundown, __toString)
{
sundown__render(SUNDOWN_RENDER_HTML,INTERNAL_FUNCTION_PARAM_PASSTHRU);
}
/* }}} */

/* {{{ proto string to_toc()
/* {{{ proto string Sundonw::to_toc()
Returns table of contents*/
PHP_METHOD(sundown, to_toc)
{
Expand All @@ -336,6 +336,7 @@ PHP_METHOD(sundown, to_toc)
static zend_function_entry php_sundown_methods[] = {
PHP_ME(sundown, __construct, arginfo_sundown__construct, ZEND_ACC_PUBLIC)
PHP_ME(sundown, __destruct, NULL, ZEND_ACC_PUBLIC)
/* to_html and to_toc methods are compatible with Redcarpet */
PHP_ME(sundown, to_html, NULL, ZEND_ACC_PUBLIC)
PHP_ME(sundown, to_toc, NULL, ZEND_ACC_PUBLIC)
PHP_ME(sundown, __toString, NULL, ZEND_ACC_PUBLIC)
Expand Down Expand Up @@ -382,6 +383,7 @@ zend_module_entry sundown_module_entry = {
void php_sundown_init(TSRMLS_D)
{
zend_class_entry ce;

INIT_CLASS_ENTRY(ce, "Sundown", php_sundown_methods);
sundown_class_entry = zend_register_internal_class(&ce TSRMLS_CC);
zend_declare_property_null(sundown_class_entry, "extensions", sizeof("extensions")-1, ZEND_ACC_PUBLIC TSRMLS_CC);
Expand Down
60 changes: 30 additions & 30 deletions src/render_base.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_sundown_render_base_postprocess, 0, 0, 1)
ZEND_ARG_INFO(0, full_document)
ZEND_END_ARG_INFO()

/* {{{ proto string block_code($code, $language)
/* {{{ proto string Sundown\Render\Base::block_code($code, $language)
*/
PHP_METHOD(sundown_render_base, block_code)
{
Expand All @@ -194,7 +194,7 @@ PHP_METHOD(sundown_render_base, block_code)
}
/* }}} */

/* {{{ proto string block_quote($quote)
/* {{{ proto string Sundown\Render\Base::block_quote($quote)
*/
PHP_METHOD(sundown_render_base, block_quote)
{
Expand All @@ -210,7 +210,7 @@ PHP_METHOD(sundown_render_base, block_quote)
}
/* }}} */

/* {{{ proto string block_html($raw_html)
/* {{{ proto string Sundown\Render\Base::block_html($raw_html)
*/
PHP_METHOD(sundown_render_base, block_html)
{
Expand All @@ -226,7 +226,7 @@ PHP_METHOD(sundown_render_base, block_html)
}
/* }}} */

/* {{{ proto string header($htext,$header_level)
/* {{{ proto string Sundown\Render\Base::header($htext,$header_level)
*/
PHP_METHOD(sundown_render_base, header)
{
Expand All @@ -242,7 +242,7 @@ PHP_METHOD(sundown_render_base, header)
}
/* }}} */

/* {{{ proto string hrule()
/* {{{ proto string Sundown\Render\Base::hrule()
*/
PHP_METHOD(sundown_render_base, hrule)
{
Expand All @@ -252,7 +252,7 @@ PHP_METHOD(sundown_render_base, hrule)
}
/* }}} */

/* {{{ proto string list_box($contents, $list_type)
/* {{{ proto string Sundown\Render\Base::list_box($contents, $list_type)
*/
PHP_METHOD(sundown_render_base, list_box)
{
Expand All @@ -269,7 +269,7 @@ PHP_METHOD(sundown_render_base, list_box)
}
/* }}} */

/* {{{ proto string list_item($text, $list_type)
/* {{{ proto string Sundown\Render\Base::list_item($text, $list_type)
*/
PHP_METHOD(sundown_render_base, list_item)
{
Expand All @@ -286,7 +286,7 @@ PHP_METHOD(sundown_render_base, list_item)
}
/* }}} */

/* {{{ proto string paragraph($text)
/* {{{ proto string Sundown\Render\Base::paragraph($text)
*/
PHP_METHOD(sundown_render_base, paragraph)
{
Expand All @@ -303,7 +303,7 @@ PHP_METHOD(sundown_render_base, paragraph)
}
/* }}} */

/* {{{ proto string table($header, $body)
/* {{{ proto string Sundown\Render\Base::table($header, $body)
*/
PHP_METHOD(sundown_render_base, table)
{
Expand All @@ -319,7 +319,7 @@ PHP_METHOD(sundown_render_base, table)
}
/* }}} */

/* {{{ proto string table_row($content)
/* {{{ proto string Sundown\Render\Base::table_row($content)
*/
PHP_METHOD(sundown_render_base, table_row)
{
Expand All @@ -335,7 +335,7 @@ PHP_METHOD(sundown_render_base, table_row)
}
/* }}} */

/* {{{ proto string table_cell($content, $alignment)
/* {{{ proto string Sundown\Render\Base::table_cell($content, $alignment)
*/
PHP_METHOD(sundown_render_base, table_cell)
{
Expand All @@ -351,7 +351,7 @@ PHP_METHOD(sundown_render_base, table_cell)
}
/* }}} */

/* {{{ proto string autolink($link, $link_type)
/* {{{ proto string Sundown\Render\Base::autolink($link, $link_type)
*/
PHP_METHOD(sundown_render_base, autolink)
{
Expand All @@ -367,7 +367,7 @@ PHP_METHOD(sundown_render_base, autolink)
}
/* }}} */

/* {{{ proto string codespan($code)
/* {{{ proto string Sundown\Render\Base::codespan($code)
*/
PHP_METHOD(sundown_render_base, codespan)
{
Expand All @@ -383,7 +383,7 @@ PHP_METHOD(sundown_render_base, codespan)
}
/* }}} */

/* {{{ proto string double_emphasis($text)
/* {{{ proto string Sundown\Render\Base::double_emphasis($text)
*/
PHP_METHOD(sundown_render_base, double_emphasis)
{
Expand All @@ -399,7 +399,7 @@ PHP_METHOD(sundown_render_base, double_emphasis)
}
/* }}} */

/* {{{ proto string emphasis($text)
/* {{{ proto string Sundown\Render\Base::emphasis($text)
*/
PHP_METHOD(sundown_render_base, emphasis)
{
Expand All @@ -416,7 +416,7 @@ PHP_METHOD(sundown_render_base, emphasis)
}
/* }}} */

/* {{{ proto string image($link, $title, $alt_text)
/* {{{ proto string Sundown\Render\Base::image($link, $title, $alt_text)
*/
PHP_METHOD(sundown_render_base, image)
{
Expand All @@ -432,7 +432,7 @@ PHP_METHOD(sundown_render_base, image)
}
/* }}} */

/* {{{ proto string linebreak()
/* {{{ proto string Sundown\Render\Base::linebreak()
*/
PHP_METHOD(sundown_render_base, linebreak)
{
Expand All @@ -442,7 +442,7 @@ PHP_METHOD(sundown_render_base, linebreak)
}
/* }}} */

/* {{{ proto string link($link,$title,$content)
/* {{{ proto string Sundown\Render\Base::link($link,$title,$content)
*/
PHP_METHOD(sundown_render_base, link)
{
Expand All @@ -458,7 +458,7 @@ PHP_METHOD(sundown_render_base, link)
}
/* }}} */

/* {{{ proto string raw_html($raw_html)
/* {{{ proto string Sundown\Render\Base::raw_html($raw_html)
*/
PHP_METHOD(sundown_render_base, raw_html)
{
Expand All @@ -474,7 +474,7 @@ PHP_METHOD(sundown_render_base, raw_html)
}
/* }}} */

/* {{{ proto string triple_emphasis($text)
/* {{{ proto string Sundown\Render\Base::triple_emphasis($text)
*/
PHP_METHOD(sundown_render_base, triple_emphasis)
{
Expand All @@ -490,7 +490,7 @@ PHP_METHOD(sundown_render_base, triple_emphasis)
}
/* }}} */

/* {{{ proto string strikethrough($text)
/* {{{ proto string Sundown\Render\Base::strikethrough($text)
*/
PHP_METHOD(sundown_render_base, strikethrough)
{
Expand All @@ -506,7 +506,7 @@ PHP_METHOD(sundown_render_base, strikethrough)
}
/* }}} */

/* {{{ proto string superscript($text)
/* {{{ proto string Sundown\Render\Base::superscript($text)
*/
PHP_METHOD(sundown_render_base, superscript)
{
Expand All @@ -522,7 +522,7 @@ PHP_METHOD(sundown_render_base, superscript)
}
/* }}} */

/* {{{ proto string entity($text)
/* {{{ proto string Sundown\Render\Base::entity($text)
*/
PHP_METHOD(sundown_render_base, entity)
{
Expand All @@ -538,7 +538,7 @@ PHP_METHOD(sundown_render_base, entity)
}
/* }}} */

/* {{{ proto string normal_text($text)
/* {{{ proto string Sundown\Render\Base::normal_text($text)
*/
PHP_METHOD(sundown_render_base, normal_text)
{
Expand All @@ -554,23 +554,23 @@ PHP_METHOD(sundown_render_base, normal_text)
}
/* }}} */

/* {{{ proto string doc_header()
/* {{{ proto string Sundown\Render\Base::doc_header()
*/
PHP_METHOD(sundown_render_base, doc_header)
{
RETURN_FALSE;
}
/* }}} */

/* {{{ proto string doc_footer()
/* {{{ proto string Sundown\Render\Base::doc_footer()
*/
PHP_METHOD(sundown_render_base, doc_footer)
{
RETURN_FALSE;
}
/* }}} */

/* {{{ proto string preprocess($full_document)
/* {{{ proto string Sundown\Render\Base::preprocess($full_document)
*/
PHP_METHOD(sundown_render_base, preprocess)
{
Expand All @@ -586,7 +586,7 @@ PHP_METHOD(sundown_render_base, preprocess)
}
/* }}} */

/* {{{ proto string postprocess($full_document)
/* {{{ proto string Sundown\Render\Base::postprocess($full_document)
*/
PHP_METHOD(sundown_render_base, postprocess)
{
Expand All @@ -609,7 +609,7 @@ PHP_METHOD(sundown_render_base, postprocess)
}
/* }}} */

/* {{{ proto __construct([array render_flags])
/* {{{ proto Sundown\Render\Base::__construct([array render_flags])
*/
PHP_METHOD(sundown_render_base, __construct)
{
Expand All @@ -628,7 +628,7 @@ PHP_METHOD(sundown_render_base, __construct)
}
/* }}} */

/* {{{ proto __destruct()
/* {{{ proto Sundown\Render\Base::__destruct()
*/
PHP_METHOD(sundown_render_base, __destruct)
{
Expand Down
Loading

0 comments on commit 77af627

Please sign in to comment.