Alt + Q on file header description

[davidAlgis]

Hi,

First, thanks for this nice plugin, it's really useful to me !
I wanted to override the auto-filled description for file header in "block_layout", I add this configuration:

{
                "tags": [
                    "",
                    "@file         {file_base_name}",
                    "",
                    "@brief        Description of the file",
                    "",
                    "@author       {user_name}",
                    "",
                    "@company      Company_name",
                    "Copyright © Company_name. All rights reserved.",
                    "",
                ],
                "context": [
                    {
                        "key": "row",
                        "operator": "equal",
                        "operand": "0"
                    },
                    {
                        "key": "kind",
                        "operator": "equal",
                        "operand": ""
                    }
                ]
            },

However, when I trigger Alt+S on the first line (which is empty) of any file, it doesn't do anything or if I'm in a class it will directly go on the comment of the class below. The context seems good, as I only copy/paste the one from "block_layout_default". Is there something I don't understand ?

Thanks in advance.

[20Tauri]

Hi,

You probably mean Alt+Q.
This shortcut currently comment the nearest entity (context if not check to see if there's a better rule)
I don't know the language used and the docstyle used (note than @company is currently unknown whatever the docstyle)

I will assume that you use PHP:
<?php
///<-- ENTER here should generate the expected result

Your configuration seems ok.
Please consider adding a block_layout section rather than override the default section.

Regards

[davidAlgis]

Sorry, my question was not precise enough. I'll try to be more precise:

I have a c++ project and I want that when I press Alt + Q (not S indeed) on the first line of the file, which should be empty, it has to write the following comment :

/**
 * @file {file_base_name}
 * @brief Description of the file
 *
 * @author {user_name}
 *
 * Company - {company_name}
 * Copyright © {company_name}. All rights reserved.
 */

Therefore, I update the Doxy user sublime settings :

// Settings in here override those in "${packages}/DoxyDoxygen/Doxy.sublime-settings",
// and are overridden in turn by syntax-specific settings.
{
    "debug_enabled": true,
    "block_layout": {
        "Doxygen": [
            // Auto-Filled description for a class
            {
                "tags": [
                    "",
                    "@class        {name}",
                    "",
                    "@brief        Description of the class"
                ],
                "context": [
                    {
                        "key": "kind",
                        "operator": "equal",
                        "operand": "class"
                    }
                ]
            },
            // Auto-filled description for file header
            {
                "tags": [
                    "",
                    "@file         {file_base_name}",
                    "",
                    "@brief        Description of the file",
                    "",
                    "@author       {user_name}",
                    "",
                    "Company       Studio Nyx",
                    "Copyright © Studio Nyx. All rights reserved.",
                    "",
                ],
                "context": [
                    {
                        "key": "row",
                        "operator": "equal",
                        "operand": "0"
                    },
                    {
                        "key": "kind",
                        "operator": "equal",
                        "operand": ""
                    }
                ]
            },
            {
                "tags": [
                    "@brief            Gets {name:doxy_words(1,);doxy_lower();}.",
                    "@return           {name:doxy_words(1,);doxy_capitalize();}"
                ],
                "context": [
                    {
                        "key": "{name:doxy_words(0);doxy_lower();}",
                        "operator": "equal",
                        "operand": "get"
                    }
                ]
            },
        ],
    },
}

But when I press Alt + Q it'll just go the nearest entity.
I have you an idea of what is wrong ? Is it my config file ? Or even my idea cannot be implemented with your plugin ?

Thanks in advance,

[20Tauri]

The answer still the same.

The approach described above could be implemented as follows:

    {
        "keys": ["alt+s"],
        "command": "doxy_chain_commands",
        "args": {
            "commands": [
                [ "view.doxy_insert", { "msg": "/**" } ],
                [ "view.move_to",     { "to": "eol", "extend": false} ],
                [ "view.doxy_enter" ]
            ]
        },
        "context": [
            /* please refer to the SublimeText documentatino to improve the condition */
            { "key": "selector",              "operator": "equal",  "operand": "source.c++" }
        ]
    }

Changing the default Alt+Q keyboard shortcut when the file is empty is also logical and would make the above modification unnecessary. This could be a future enhancement.

[20Tauri]

The planned task will be: Alt+Q now tries to fall back on current location rule when no entity has been found

In order to establish an order of priority, how many registered users in your company are interested in this modification?

[davidAlgis]

I am the only one in my company to use it ^^
At the moment I'm using a snippet which is working solution, I just thought it will be possible with doxydoxygen.
In any case, thanks for your answer !

[20Tauri]

The change has been included to 0.83.0 (evolution branch only for now).
It will also add a better C++23 support and new Doxygen commands.

[davidAlgis]

Nice, thanks a lot !
I'll be waiting for the release of this version then.