search

TabletopAssistant / DiceKit

Swift framework for expressing and evaluating dice notation (e.g., d20, 4d6+4, 3d8×10+2), which is commonly used in tabletop role-playing games.
Apache License 2.0
14 stars 1 forks source link

Add Top Level documentation to all public types #85

Open brentleyjones opened 9 years ago

JonathanHoffman commented 9 years ago

What do you have in mind for this? Sections or pages in a playground? New doc file? Github wiki?

brentleyjones commented 9 years ago

The /// An imaginary die but for all public types. Docstrings for all public types. Another issue will be for all public properties. Another will be for all public methods. Another will be for all public functions :smile:.

JonathanHoffman commented 9 years ago

Oh I see. I've been thinking about how certain code can be made easier to understand with comments and docstrings.