Skip to content

Commit

Permalink
Merge pull request #1502 from hydephp/normalize-code-comments
Browse files Browse the repository at this point in the history
Clean up and normalize class description comments
  • Loading branch information
caendesilva authored Dec 14, 2023
2 parents 5029740 + 724fc2b commit 56f3bf8
Show file tree
Hide file tree
Showing 24 changed files with 31 additions and 20 deletions.
1 change: 1 addition & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This serves two purposes:

### Changed
- Shortened the path printed to console when using the dashboard to create a page in https://github.com/hydephp/develop/pull/1492
- Code cleanup and style improvements in https://github.com/hydephp/develop/pull/1501 and https://github.com/hydephp/develop/pull/1502

### Deprecated
- for soon-to-be removed features.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use LaravelZero\Framework\Commands\Command;

/**
* Hyde command to run the build process for the RSS feed.
* Run the build process for the RSS feed.
*/
class BuildRssFeedCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use LaravelZero\Framework\Commands\Command;

/**
* Hyde command to run the build process for the documentation search index.
* Run the build process for the documentation search index.
*/
class BuildSearchCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
use function app;

/**
* Hyde Command to run the Build Process.
* Run the static site build process.
*/
class BuildSiteCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
use LaravelZero\Framework\Commands\Command;

/**
* Hyde command to run the build process for the sitemap.
* Run the build process for the sitemap.
*/
class BuildSitemapCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@
use function basename;
use function realpath;

/**
* Change the source directory for your project.
*/
class ChangeSourceDirectoryCommand extends Command
{
/** @var string */
Expand Down
2 changes: 1 addition & 1 deletion packages/framework/src/Console/Commands/DebugCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
use function app;

/**
* Hyde Command to print debug information.
* Print debug information.
*/
class DebugCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
use function ucfirst;

/**
* Hyde Command to scaffold a new Markdown or Blade page file.
* Scaffold a new Markdown or Blade page file.
*/
class MakePageCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
use function ucwords;

/**
* Hyde Command to scaffold a new Markdown Post.
* Scaffold a new Markdown blog post file.
*/
class MakePostCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
use Illuminate\Foundation\Console\PackageDiscoverCommand as BaseCommand;
use Illuminate\Foundation\PackageManifest;

/**
* Extended package discovery command to use the custom manifest path.
*/
class PackageDiscoverCommand extends BaseCommand
{
/** @var true */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
use function sprintf;

/**
* Publish the Hyde Config Files.
* Publish the Hyde config files.
*/
class PublishConfigsCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
use function strstr;

/**
* Publish one of the default homepages.
* Publish one of the default homepages to index.blade.php.
*/
class PublishHomepageCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
use function unslash;

/**
* Hyde Command to build a single static site file.
* Build a single static site file.
*/
class RebuildPageCommand extends Command
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
use function sprintf;

/**
* Hyde command to display the list of site routes.
* Display the list of site routes.
*/
class RouteListCommand extends Command
{
Expand Down
3 changes: 3 additions & 0 deletions packages/framework/src/Console/Commands/ValidateCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
use function sprintf;
use function sizeof;

/**
* Run a series of tests to validate your setup and help you optimize your site.
*/
class ValidateCommand extends Command
{
use TracksExecutionTime;
Expand Down
3 changes: 2 additions & 1 deletion packages/framework/src/Foundation/Kernel/RouteCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
use Hyde\Support\Models\Route;

/**
* The RouteCollection contains all the routes, making it the Pseudo-Router for Hyde.
* The RouteCollection contains all the page routes, making it the pseudo-router for Hyde,
* as it maps each page to the eventual URL that will be used to access it once built.
*
* @template T of \Hyde\Support\Models\Route
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
use Hyde\Pages\Concerns\HydePage;

/**
* Converts a Page Model into a static HTML page.
* Converts a Hyde page object into a static HTML page.
*/
class StaticPageBuilder
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
use function blank;

/**
* Adds methods to a class to allow it to fluently interact with the front matter.
* Adds methods to a class to allow it to fluently interact with its front matter.
*/
trait InteractsWithFrontMatter
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
use function is_string;

/**
* The Post Author model object.
* Object representation of a post author for the site.
*/
class PostAuthor implements Stringable
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
use function str_starts_with;

/**
* Hyde Command to create a new publication for a given publication type.
* Hyde command to create a new publication for a given publication type.
*
* @see \Hyde\Publications\Actions\CreatesNewPublicationPage
* @see \Hyde\Publications\Testing\Feature\MakePublicationCommandTest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
use function strtolower;

/**
* Hyde Command to create a new publication type.
* Hyde command to create a new publication type.
*
* @see \Hyde\Publications\Actions\CreatesNewPublicationType
* @see \Hyde\Publications\Testing\Feature\MakePublicationTypeCommandTest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
use function sprintf;

/**
* Hyde Command to seed publication files for a publication type.
* Hyde command to seed publication files for a publication type.
*
* @see \Hyde\Publications\Actions\SeedsPublicationFiles
* @see \Hyde\Publications\Testing\Feature\SeedPublicationCommandTest
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
use function sprintf;

/**
* Hyde Command to validate all publication schema file..
* Hyde command to validate all publication schema file..
*
* @see \Hyde\Publications\Testing\Feature\ValidatePublicationTypesCommandTest
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
use function substr_count;

/**
* Hyde Command to validate one or all publications.
* Hyde command to validate one or all publications.
*
* @see \Hyde\Publications\Testing\Feature\ValidatePublicationsCommandTest
*
Expand Down

0 comments on commit 56f3bf8

Please sign in to comment.