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.

Sign up for GitHub

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

Jump to bottom

Including Punctuation Marks #3439

Merged
merged 3 commits into from
Jan 30, 2023
Merged

Including Punctuation Marks #3439

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a18128
Update README.md
BirdboyBolu Jan 26, 2023
68197d2
Update README.md
BirdboyBolu Jan 26, 2023
6512042
Update README.md
BirdboyBolu Jan 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ What is phpDocumentor?
phpDocumentor is an application that is capable of analyzing your PHP source code and
DocBlock comments to generate a complete set of API Documentation.

Inspired by phpDocumentor 1 and JavaDoc it continues to innovate and is up to date with the latest technologies and PHP language features.
Inspired by phpDocumentor 1 and JavaDoc, it continues to innovate and is up to date with the latest technologies and PHP language features.

phpDocumentor v3 (Stable)
------------------------------------
Expand All @@ -24,7 +24,7 @@ v3 is the latest stable release.
Documentation
-------------

For more detailed information you can check our online documentation at https://docs.phpdoc.org/.
For more detailed information, you can check our online documentation at https://docs.phpdoc.org/.

Features
--------
Expand All @@ -34,7 +34,7 @@ phpDocumentor supports the following:
* *PHP 7.0+ compatible*, full support for Namespaces, Closures and more are provided.
* *Docblock over types*, docblocks can be more explicit about types not all formats are supported by native php.
* *Shows any tag*, some tags add additional functionality to phpDocumentor (such as @link).
* *Low memory usage*, peak memory usage for small projects is less than 20MB, medium projects 40MB and large frameworks 100MB.
* *Low memory usage*, peak memory usage for small projects is less than 20MB, medium projects 40MB, and large frameworks 100MB.
* *Incremental parsing*, if you kept the Structure file from a previous run, you get an additional performance boost of up
to 80% on top of the mentioned processing speed increase above.
* *Easy template building*, if you want to make a branding you only have to call 1 task and edit 3 files.
Expand All @@ -54,7 +54,7 @@ This will require the application [Graphviz] to be installed on the machine runn
Rendering the class diagrams using [Graphviz] is optional, and warnings about missing [Graphviz] can be ignored.
However, your documentation will contain some dead links in this case. Class diagram will be created with option `--setting=graphs.enabled=true`.

There are 3 ways to install phpDocumentor:
There are 4 ways to install phpDocumentor:

1. Using phive (recommended)
2. Using the PHAR (manual install)
Expand Down