Comments (5)
Definitely in a Nested Types section, possibly before all other members since that's how IL Spy orders things, though I could also see an argument for putting them last. They could even be listed below Derived Types next to the class diagram, though that doesn't have room for their summary so I wouldn't want only that.
I'm not sure how they could fit into the sidebar though since there really isn't much room to work with. Some of my outer classes already take up two lines, so repeating the full name for each nested class would probably be bad. Simply indenting the nested class names under their outer class could work, perhaps even just using a cumulative ...
prefix for each nesting level instead of actual indentation. Or a foldout arrow like the docs sidebar uses could work too.
from statiq.docs.
Good call - any suggestions where/how they should be listed UI-wise? Alongside outer classes with qualified names maybe? Or only on the page of their containing classes, maybe in a Nested Types section?
from statiq.docs.
With Statiq.Docs nested types no longer seem to be available through search either
from statiq.docs.
This seems like a regression, I could swear we had them working. I'll add it to the growing list of stuff 😂.
(On that note, we keep pushing towards a release at work, hence my lack of availability during crunch time. Eventually that'll pass and I'll be able to spend some time here - just don't know when that'll be yet.)
from statiq.docs.
Sorry, my mistake. Nested types are still available through search, but only when searching for out class (e.g. when having Foo
nested inside Bar
, searching for Foo
won't find it, but searching for Bar
since it is called Bar.Foo
)
But having them listed inside the parent class inside a nested types section still would be useful.
from statiq.docs.
Related Issues (20)
- Struct syntax shows unnecessary inheritance from ValueType
- Enum Docs sort members by name rather than by value
- <seealso> tags don't link to the specified member HOT 1
- Active class in table header rows HOT 1
- Add xrefs for all API symbols
- Support for Markdown format
- Verify doc comments specification HOT 1
- Feature Request: support XML <include> tags
- GetTypeLink fails for tuples HOT 6
- Add support for automatically linking symbols
- Add support for langword
- Add the props file from Statiq.Web to Statiq.Docs HOT 2
- AddAssemblyFiles to populate "API"?
- Source files are ignored by generator HOT 11
- Xrefs for API symbols should not contain whitespace
- Methods from base class not listed if base class is generic
- Example on Statiq.Docs output HOT 1
- File Casing issue when deploying to GH-Pages HOT 1
- Support for type-safe enum pattern. HOT 2
- [duplicate] xref API Reference Link Generation Issue Adding Extra Space HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from statiq.docs.