Skip to content

Add filename to code examples #35

@Derky

Description

@Derky

As requested by @nickvergessen I'm adding this as an issue:

It's really useful to see the filename in example code like Symfony's documentation has. I don't think it's necessary for all example code, but especially for large code blocks andcomplete files it is.

Maybe with /ext/ and the full path?

// ext/acme/demo/acp/main_module.php

E.g.

// ext/acme/demo/acp/main_module.php
<?php
/**
 *
 * This file is part of the phpBB Forum Software package.
 *
 * @copyright (c) phpBB Limited <https://www.phpbb.com>
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 * For full copyright and license information, please see
 * the docs/CREDITS.txt file.
 *
 */

namespace acme\demo\acp;

class main_info
{
    public function module()
    {
        return array(
            'filename'      => '\acme\demo\acp\main_module',
            'title'         => 'ACP_DEMO_TITLE',
            'version'       => '1.0.0',
            'modes'         => array(
                'settings' => array(
                    'title' => 'ACP_DEMO',
                    'auth'  => 'ext_acme/demo && acl_a_board',
                    'cat'   => array('ACP_DEMO_TITLE'),
                ),
            ),
        );
    }
}

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions