malhuda/fictioneer
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 112 Wiki Activity

Update some doc comments

Browse Source 
Going for an unified style.
This commit is contained in:
Tetrakern 2023-08-03 20:39:31 +02:00
parent adec4ea2a1
commit d681de4fde
4 changed files with 30 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
includes/functions/hooks/_general_hooks.php
View File

@ -46,9 +46,9 @@ if ( ! function_exists( 'fictioneer_breadcrumbs' ) ) {
*
* @since Fictioneer 5.0
*
* @param array $args['breadcrumbs'] Breadcrumb tuples with label (0) and link (1).
* @param string $args['post_type'] Optional. Post type of the current page.
* @param int $args['post_id'] Optional. Post ID of the current page.
* @param int|null $args['post_id'] Optional. Post ID of the current page.
* @param string|null $args['post_type'] Optional. Post type of the current page.
* @param array $args['breadcrumbs'] Breadcrumb tuples with label (0) and link (1).
*/
function fictioneer_breadcrumbs( $args ) {
@ -115,8 +115,8 @@ if ( ! function_exists( 'fictioneer_output_modals' ) ) {
*
* @since Fictioneer 5.0.0
*
* @param int|null $args['post_id'] Current post ID or null.
* @param string|null $args['post_type'] Current post type or null.
* @param int|null $args['post_id'] Optional. Current post ID.
* @param string|null $args['post_type'] Optional. Current post type.
* @param array $args['breadcrumbs'] Array of breadcrumb tuples with label (0) and link (1).
*/
@ -180,10 +180,10 @@ if ( ! function_exists( 'fictioneer_navigation_bar' ) ) {
*
* @since Fictioneer 5.0
*
* @param int|null $args['post_id'] Current post ID or null.
* @param int|null $args['story_id'] Current story ID (if chapter) or null.
* @param string|boolean $args['header_image_url'] URL of the filtered header image or false.
* @param array $args['header_args'] Arguments passed to the header.php partial.
* @param int|null $args['post_id'] Optional. Current post ID.
* @param int|null $args['story_id'] Optional. Current story ID (if chapter).
* @param string|boolean $args['header_image_url'] URL of the filtered header image or false.
* @param array $args['header_args'] Arguments passed to the header.php partial.
*/
function fictioneer_navigation_bar( $args ) {
@ -202,10 +202,10 @@ if ( ! function_exists( 'fictioneer_site_header' ) ) {
*
* @since Fictioneer 5.0
*
* @param int|null $args['post_id'] Current post ID or null.
* @param int|null $args['story_id'] Current story ID (if chapter) or null.
* @param string|boolean $args['header_image_url'] URL of the filtered header image or false.
* @param array $args['header_args'] Arguments passed to the header.php partial.
* @param int|null $args['post_id'] Optional. Current post ID.
* @param int|null $args['story_id'] Optional. Current story ID (if chapter).
* @param string|boolean $args['header_image_url'] URL of the filtered header image or false.
* @param array $args['header_args'] Arguments passed to the header.php partial.
*/
function fictioneer_site_header( $args ) {
@ -225,10 +225,10 @@ if ( ! function_exists( 'fictioneer_header_background' ) ) {
*
* @since Fictioneer 5.0
*
* @param int|null $args['post_id'] Current post ID or null.
* @param int|null $args['story_id'] Current story ID (if chapter) or null.
* @param string|boolean $args['header_image_url'] URL of the filtered header image or false.
* @param array $args['header_args'] Arguments passed to the header.php partial.
* @param int|null $args['post_id'] Optional. Current post ID.
* @param int|null $args['story_id'] Optional. Current story ID (if chapter).
* @param string|boolean $args['header_image_url'] URL of the filtered header image or false.
* @param array $args['header_args'] Arguments passed to the header.php partial.
*/
function fictioneer_header_background( $args ) {

9
includes/functions/hooks/_mobile_menu_hooks.php
View File

@ -14,10 +14,10 @@ if ( ! function_exists( 'fictioneer_output_mobile_menu' ) ) {
*
* @since Fictioneer 5.0
*
* @param int|null $args['post_id'] Current post ID or null.
* @param int|null $args['story_id'] Current story ID (if chapter) or null.
* @param string|boolean $args['header_image_url'] URL of the filtered header image or false.
* @param array $args['header_args'] Arguments passed to the header.php partial.
* @param int|null $args['post_id'] Optional. Current post ID.
* @param int|null $args['story_id'] Optional. Current story ID (if chapter).
* @param string|boolean $args['header_image_url'] URL of the filtered header image or false.
* @param array $args['header_args'] Arguments passed to the header.php partial.
*/
function fictioneer_output_mobile_menu( $args ) {
@ -72,6 +72,7 @@ if ( ! function_exists( 'fictioneer_mobile_quick_buttons' ) ) {
$output = [];
// Build
ob_start();
// Start HTML ---> ?>
<label for="site-setting-minimal" class="button _quick"><span><?php _e( 'Minimalist', 'fictioneer' ); ?></span></label>

8
partials/_navigation.php
View File

@ -8,10 +8,10 @@
* @subpackage Fictioneer
* @since 5.0
*
* @internal $args['post_id'] Current post ID or null.
* @internal $args['story_id'] Current story ID (if chapter) or null.
* @internal $args['header_image_url'] URL of the filtered header image or false.
* @internal $args['header_args'] Arguments passed to the header.php partial.
* @internal $args['post_id'] Optional. Current post ID.
* @internal $args['story_id'] Optional. Current story ID (if chapter).
* @internal $args['header_image_url'] URL of the filtered header image or false.
* @internal $args['header_args'] Arguments passed to the header.php partial.
*/
?>

8
partials/_site-header.php
View File

@ -8,10 +8,10 @@
* @subpackage Fictioneer
* @since 5.0
*
* @internal $args['post_id'] Current post ID or null.
* @internal $args['story_id'] Current story ID (if chapter) or null.
* @internal $args['header_image_url'] URL of the filtered header image or false.
* @internal $args['header_args'] Arguments passed to the header.php partial.
* @internal $args['post_id'] Optional. Current post ID.
* @internal $args['story_id'] Optional. Current story ID (if chapter).
* @internal $args['header_image_url'] URL of the filtered header image or false.
* @internal $args['header_args'] Arguments passed to the header.php partial.
*/
?>