aarondandy / ducky-docs Goto Github PK

Oh yeah, and also nullables should go to the core type.

need a special view model and view for delegates, also short names

Maybe some kind of parser? Leave unknown nodes as is convert the others to parsed cref objects? or provide some kind of stream reader that can parse the text and resolve references within (most flexible)?

flag a class/method as sealed somehow

parameter and return types need to both link to the correct internal and external location

watch out for

• generics
• arrays

contravariance and covariance docs (in/out)

Will need to research security to make sure everything is safe

Need to do proper type linking for see and seealso tags.

Also show what type a member was inherited from.

what about tostring hashcode type etc.?

How should enumerations be handled.

Make sure that global namespaces dont break stuff.

Make a nice title for a generic type, including parameters. instead of just Generic'2

Start over using a layered approach. This will allow for better extensibility and reduce redundant code.

when loading a type or member the namespace should be expanded and the type name should be scrolled into view.

Make sure that public member in private or internal types are not classified as externally exposed.

remove double negations from exception conditions which are generated by CC

Instead of using a bunch of terrible properties to switch operation it should use a heavily modified (through inheritance) display name generator, use its own code, or all of them should come from some base c style code generator

need to indicate that something is an override

Short display names should only include parameters if there are other visible overloads

Support for explicit interface method/property implementations

• $InvariantMethod$
• $evaluatingInvariant$

need to list generic type parameters and generic method parameters

Would like to also get summary information.

Need a nice table on a member page to fully describe the flair badges it has.

instead of a list of strings for flair I probably need a class with

• icon (the current string, used for the icon)
• detailName
• detailDescription

for properties for example, this can be applied to the getter and setter as independent MethodViewModels as well as to the property. That may get too busy though, maybe exclude from the property table the items that are already in the getter or setter? Purity for example?

• Reduce the number of instances
• clean things up
• include view models for items not in the AssemblyDefinitionCollection such as System.Object to easily cache the properties

use the breadcrumbs feature

Not everyone will offer 4.5 hosting or have upgraded. best to hold off until there is a real need for 4.5 or have those features in another assembly

the requires table needs proper exception type links and names

each method/property should have coverage metrics