Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
dumux
dumux
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 93
    • Issues 93
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 73
    • Merge Requests 73
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • dumux-repositories
  • dumuxdumux
  • Issues
  • #793

Closed
Open
Opened Nov 29, 2019 by Timo Koch@timokOwner

[examples] Allow to exclude/fold code in the example README.md

For long files and class with a lot of boilerplate code it might be good to be able to exclude stuff from the automatically generated doc. This is probably possible by defining a keyword like

//[begin exclude]
...
//[end exclude]

Another idea would be (as an alternative or additionally to the suggestion above) to allow collapsible code snippet as demonstrated here:

Click to expand code snippet
   class Class {
       using Boilerplate = Code; 
       using Boilerplate = Code; 
       using Boilerplate = Code; 
       using Boilerplate = Code; 
       using Boilerplate = Code; 
   };

This could be also achieved with a keyword like

//[begin fold]
...
//[end fold]

Related MRs: !1682 (merged)

Edited Jan 29, 2020 by Melanie Lipp
Assignee
Assign to
3.2
Milestone
3.2 (Past due)
Assign milestone
Time tracking
None
Due date
None
Reference: dumux-repositories/dumux#793