nystudio107 / craft-templatecomments

src/config.php

<?php
/**
 * Template Comments plugin for Craft CMS
 *
 * Adds a HTML comment to demarcate each Twig template that is included or
 * extended.
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c)  nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

/**
 * Template Comments config.php
 *
 * This file exists only as a template for the Instant Analytics settings.
 * It does nothing on its own.
 *
 * Don't edit this file, instead copy it to 'craft/config' as
 * 'templatecomments.php' and make your changes there to override default
 * settings.
 *
 * Once copied to 'craft/config', this file will be multi-environment aware as
 * well, so you can have different settings groups for each environment, just
 * as
 * you do for 'general.php'
 */

return [
    /**

Missing short description in doc comment

     * @var bool Whether comments should be generated for site templates
     */
    'siteTemplateComments' => true,

    /**

Missing short description in doc comment

     * @var bool Whether comments should be generated for Control Panel templates
     */
    'cpTemplateComments' => false,

    /**

Missing short description in doc comment

     * @var bool Whether to generate comments only when `devMode` is on
     */
    'onlyCommentsInDevMode' => true,

    /**

Missing short description in doc comment

     * @var array Don't add comments to template blocks that contain these strings (case-insensitive)
     */
    'excludeBlocksThatContain' => [
        'css',
        'js',
        'javascript',
    ],

    /**

Missing short description in doc comment

     * @var bool Whether or not to show comments for templates that are include'd
     */
    'templateCommentsEnabled' => true,

    /**

Missing short description in doc comment

     * @var bool Whether or not to show comments for `{% block %}`s
     */
    'blockCommentsEnabled' => true,

    /**

Missing short description in doc comment

     * @var array Template file suffixes that Template Comments should be enabled for
     */
    'allowedTemplateSuffixes' => [
        '',
        'twig',
        'htm',
        'html',
    ],
];