-
-
Notifications
You must be signed in to change notification settings - Fork 633
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
File Name too long error #1113
Comments
Can you show me an example of a DocBlock causing this issue? Due to the description of your issue I get the feeling that the order of the elements in your DocBlocks are incorrect (the expected order is always Summary -> Description -> Tags). If a long piece of text, such as a description follows the |
This is essentially what is happening. the description is below the package tag. I feel like even with that user error there should be some safe fail so that it doesn't kill the file creation if that name is too long. You could get to an issue where the file path of there php is running, + a really long namespace tree could cause this error as well (as unlikely as it is)
|
I have marked this issue as an improvement since I agree with you that it is good form to be defensive and prevent these kind of issues as much as possible. |
This issue is more than 10 years old. phpDocumentor has been changed a lot. If this is still an issue for anyone please open a new issue. |
The Issue
File names can have multiple lines and be too long to write to, causing documentation to be incomplete
What it should do
Parse the first line of the package tag AND truncate the max length OR
remove newlines AND truncate the max length OR
throw an exception to stop the program since the documentation will be incomplete.
Details
I get a warning when a description is below the @Package tag. This is an error with the description. and not the focus of this ticket.
Rather, the file put should be checking for a single line for a filename, and should ensure this dosnt occur by either parsing the filename to a single line, or throwing an exception so the process stops since this is obviously an error that will break the documentation.
Since the file was not written, this package is now missing from the documentation as a detailed page.
Warning Output:
The text was updated successfully, but these errors were encountered: