Prakash Raman
Prakash Raman

Reputation: 13933

Prevent a method from being documented [PHPDOC / SAMI]

This is my first run at generating API documentation. I am playing around with Sami and phpdoc.

I would like to know how I can prevent a method from being documented ?

Any help would be appreciated. Thanks.

Upvotes: 1

Views: 131

Answers (1)

hek2mgl
hek2mgl

Reputation: 158000

In phpdoc it is done using the @ignore tag:

/**
 * @ignore
 */
function secret() {

}

Upvotes: 1

Related Questions