Skip to content

Commit

Permalink
Docs: add perfunctory class and file docblocks and fix existing (#53)
Browse files Browse the repository at this point in the history
These could do with improvement, but this is a step in the right direction.

* Added file and class docblocks where these were missing.
* Added minimal tags to the existing file docblock of the main plugin file.
  • Loading branch information
jrfnl authored and Adam Silverstein committed Mar 25, 2019
1 parent e9c53ad commit 5063639
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 1 deletion.
7 changes: 7 additions & 0 deletions tests/bootstrap.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
<?php
/**
* Set up the environment for running the unit tests.
*
* @package WordPress\Plugins\WP_Post_Meta_Revisions
* @link https://github.com/adamsilverstein/wp-post-meta-revisions
* @license http://creativecommons.org/licenses/GPL/2.0/ GNU General Public License, version 2 or higher
*/

$_tests_dir = getenv( 'WP_TESTS_DIR' );

Expand Down
12 changes: 11 additions & 1 deletion tests/test-meta-revisions.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
<?php

/**
* Unit test file.
*
* @package WordPress\Plugins\WP_Post_Meta_Revisions
* @link https://github.com/adamsilverstein/wp-post-meta-revisions
* @license http://creativecommons.org/licenses/GPL/2.0/ GNU General Public License, version 2 or higher
*/

/**
* Tests for the "Post Meta Revisions" plugin.
*/
class MetaRevisionTests extends WP_UnitTestCase {

/**
Expand Down
10 changes: 10 additions & 0 deletions wp-post-meta-revisions.php
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
<?php
/**
* Post Meta Revisions, a WordPress plugin.
*
* @package WordPress\Plugins\WP_Post_Meta_Revisions
* @link https://github.com/adamsilverstein/wp-post-meta-revisions
* @license http://creativecommons.org/licenses/GPL/2.0/ GNU General Public License, version 2 or higher
*
* @wordpress-plugin
* Plugin Name: Post Meta Revisions
* Plugin URI: https://github.com/adamsilverstein/wp-post-meta-revisions
* Description: Post Meta Revisions
Expand All @@ -9,6 +16,9 @@
* License: GPLv2 or later
*/

/**
* Class WP_Post_Meta_Revisioning.
*/
class WP_Post_Meta_Revisioning {

/**
Expand Down

0 comments on commit 5063639

Please sign in to comment.