primitive-dodoc

primitive-dodoc copied to clipboard

```typescript // Checks if the documentation has to be generated for this contract const includesPath = config.include.some((str) => filePath.includes(str)); ``` The above check in [index.ts#L40](https://github.com/primitivefinance/primitive-dodoc/blob/main/index.ts#L40), seems to be causing a...

sebastiantf

Inherited event params not rendering properly

2

getting `undefined` for the params on inherited events. Currently working around the issue by copy/pasting the events from the inherited interface over to the main contract docs, but wanted to...

wminshew

Lots of `undefined` for function params descriptions

4

The generated docs are having a lot of `undefined` for some ~function parameters~ function parameters descriptions, while for some function parameters they are are appearing good, even though the Natspec...

sebastiantf

table of contents option

1

Simple functionality to support table of contents creation as `README.md` in output root.

adradr

Handle Solidity NatSpec whitespace

2

For a function specification like this: ```solidity /// @notice Perform initial contract setup /// @dev The initializer modifier ensures this is only called once, the owner should confirm this was...

fulldecent

Support for @custom tag

1

While the standard comment tags (`@notice`, `@dev`, ..) work great, Solidity also provides support for `@custom:`. Although everyone's use-case will be slightly different from custom tag, it would be super...

0x6080

Gitbook not rendering @dev properly

3

When using gitbook with dodoc, it seems the `@dev` is rendered improperly. For example: ``` /** * @dev Returns the address of the current owner. */ function owner() public view...

0x6080

Function signatures containing structs appear as `undefined`

1

I noticed that structs do not render in the docs with a description. This can be seen in the docs for `set()` in `Bar.sol` found in this repo. ```md ###...

0xCourtney

closes #37

0xCourtney

If an event is inherited it will not display anything in the description. After digging through this a bit I found that the `devdoc` and `userdoc` contain different sets of...

0xCourtney