Thread: [Doxygen-develop] Collapsible Code Fragments
Brought to you by:
dimitri
From: Jacopo P. <jpa...@gm...> - 2019-01-08 09:41:35
|
Hello Everyone, I never wrote here so I apologize if this is not the right place for feature requests, but... inspired by the output of literate programming you can find in this book: http://www.pbr-book.org/3ed-2018/Shapes/Basic_Shape_Interface.html#Shape I was wondering that the ability to mark some code blocks collapsible (e.g. inside \code / \endcode or even more importantly in \snippet sections) would make for a _great_ feature. In fact, perhaps one could reuse the block markers already present for \snippet to automatically make sub-blocks collapsible? e.g. if I had: //! [MyBlock] int a; //! [Initialize Vars] a = foo() ; //! [Initialize Vars] ... //! [MyBlock] it would be great if the HTML output for a snippet containing MyBlock contained a collapsible section referring to the block "Initialize Vars". What do you think? Best Regards, -Jacopo |
From: Albert <alb...@gm...> - 2019-01-08 09:53:00
|
Dear Jacopo, This is indeed a good place to post it, but I think an even better place would be in the doxygen issue tracker ( https://github.com/doxygen/doxygen/issues/new). As is it looks to me like a nice idea, but it will add to the complexity of the page handling and to the responsiveness. Some collapsible parts can already been seen with e.g. inherited functions and class diagrams. Albert On Tue, Jan 8, 2019 at 10:42 AM Jacopo Pantaleoni <jpa...@gm...> wrote: > Hello Everyone, > > I never wrote here so I apologize if this is not the right place for > feature requests, but... > inspired by the output of literate programming you can find in this book: > > http://www.pbr-book.org/3ed-2018/Shapes/Basic_Shape_Interface.html#Shape > > > I was wondering that the ability to mark some code blocks collapsible > (e.g. inside \code / \endcode or even more importantly in \snippet > sections) would make for a _great_ feature. > > In fact, perhaps one could reuse the block markers already present for > \snippet to automatically make sub-blocks collapsible? > > e.g. if I had: > > //! [MyBlock] > int a; > //! [Initialize Vars] > a = foo() ; > //! [Initialize Vars] > ... > //! [MyBlock] > > it would be great if the HTML output for a snippet containing MyBlock > contained a collapsible section referring to the block "Initialize Vars". > > What do you think? > > Best Regards, > -Jacopo > > _______________________________________________ > Doxygen-develop mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-develop > |
From: Jacopo P. <jpa...@gm...> - 2019-01-08 11:06:02
|
Many thanks Albert for the quick answer! I will post it to the issue tracker then. I still think it would be a great option to have, especially to write guides through the code and things like that. Perhaps it could be an opt-in feature controlled by some config, if you fear it would make things generally too slow. Jacopo On Tue, Jan 8, 2019 at 10:52 AM Albert <alb...@gm...> wrote: > Dear Jacopo, > > This is indeed a good place to post it, but I think an even better place > would be in the doxygen issue tracker ( > https://github.com/doxygen/doxygen/issues/new). > As is it looks to me like a nice idea, but it will add to the complexity > of the page handling and to the responsiveness. > Some collapsible parts can already been seen with e.g. inherited functions > and class diagrams. > > Albert > > On Tue, Jan 8, 2019 at 10:42 AM Jacopo Pantaleoni <jpa...@gm...> > wrote: > >> Hello Everyone, >> >> I never wrote here so I apologize if this is not the right place for >> feature requests, but... >> inspired by the output of literate programming you can find in this book: >> >> >> http://www.pbr-book.org/3ed-2018/Shapes/Basic_Shape_Interface.html#Shape >> >> I was wondering that the ability to mark some code blocks collapsible >> (e.g. inside \code / \endcode or even more importantly in \snippet >> sections) would make for a _great_ feature. >> >> In fact, perhaps one could reuse the block markers already present for >> \snippet to automatically make sub-blocks collapsible? >> >> e.g. if I had: >> >> //! [MyBlock] >> int a; >> //! [Initialize Vars] >> a = foo() ; >> //! [Initialize Vars] >> ... >> //! [MyBlock] >> >> it would be great if the HTML output for a snippet containing MyBlock >> contained a collapsible section referring to the block "Initialize Vars". >> >> What do you think? >> >> Best Regards, >> -Jacopo >> >> _______________________________________________ >> Doxygen-develop mailing list >> Dox...@li... >> https://lists.sourceforge.net/lists/listinfo/doxygen-develop >> > |