Skip to content

Add option to revert to behavior to skip sub-component parsing

Zachary Capalbo requested to merge zcapalbo/doxyqml:no-nested-components into master

The new (as-of https://github.com/agateau/doxyqml/pull/47 and !7 (merged)) behavior of including sub-components as private member variables along with adding spaces between separate blocks can make it more difficult to write long-runninng inline documentation, (akin to documenting a method the function body in a .cpp file, for instance). Specifically, my use case is along the lines of:

import QtQuick 2.15
import QtQml.StateMachine 1.15

/// A State containing multiple substates
State {
    /// @page stateMachine State Machine States Overview
    /// 
    /// There are a number of states in here. These are the things they do (in order):

    /// @li A state which does one thing
    State {
        id: state1
        SignalTransition {
             targetState: state2
             signal: aSignal
        }
    }

    /// @li A state which does another thing
    State {
         id: state2
    }

    /// @li The last state of all
    Final State {
         id: lastState
    }
}

This MR adds a command line flag which will restore this old behavior

Merge request reports