Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate sections for each class in API docs #4

Open
egeriis opened this issue Nov 11, 2016 · 0 comments
Open

Separate sections for each class in API docs #4

egeriis opened this issue Nov 11, 2016 · 0 comments

Comments

@egeriis
Copy link
Owner

egeriis commented Nov 11, 2016

I think it would be favorable to create a section dedicated for each class in the API docs, then a sub-section for each method below in the hierarchy. Example below

--

Dixie\LaravelModelFuture\Models\Future

Description of the purpose of this class

Illuminate\Database\Eloquent\Builder untilDate(Carbon\Carbon $date)

Query only futures scheduled between date('now') and the given date. This is an Eloquent scope.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant