Skip to content

Generators HTML/Markdown: don't print header/footer when there are no docs #687

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

Merged
merged 1 commit into from
Nov 18, 2024
Merged

Generators HTML/Markdown: don't print header/footer when there are no docs #687

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/Generators/HTML.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@ class HTML extends Generator
*/
public function generate()
{
if (empty($this->docFiles) === true) {
return;
}

ob_start();
$this->printHeader();
$this->printToc();
Expand Down
4 changes: 4 additions & 0 deletions src/Generators/Markdown.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ class Markdown extends Generator
*/
public function generate()
{
if (empty($this->docFiles) === true) {
return;
}

ob_start();
$this->printHeader();

Expand Down
78 changes: 0 additions & 78 deletions tests/Core/Generators/Expectations/ExpectedOutputNoDocs.html
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions tests/Core/Generators/Expectations/ExpectedOutputNoDocs.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion tests/Core/Generators/HTMLTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public static function dataDocs()
return [
'Standard without docs' => [
'standard' => __DIR__.'/NoDocsTest.xml',
'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputNoDocs.html',
'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt',
],
'Standard with one doc file' => [
'standard' => __DIR__.'/OneDocTest.xml',
Expand Down
2 changes: 1 addition & 1 deletion tests/Core/Generators/MarkdownTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public static function dataDocs()
return [
'Standard without docs' => [
'standard' => __DIR__.'/NoDocsTest.xml',
'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputNoDocs.md',
'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt',
],
'Standard with one doc file' => [
'standard' => __DIR__.'/OneDocTest.xml',
Expand Down