bitovi / bitovi/documentjs

Allow indentation to manage which data a tag is adding to.

Open
#85 0 comments 0 reactions 0 assignees View on GitHub
feature parsing
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

Currently, it's hard or impossible to add @return to a @option that is part of a @param like:

```
@function
@param {Object} options
@option {function(String)} name(newName)
@return {Boolean} true if successful.
```

It's impossible to know if the `@return` belongs to the outer function or the `@option` function.

Instead, if tags understood indentation ...

```
@function
@param {Object} options
@option {function(String)} name(newName)
@return {Boolean} true if successful.
```

The `@option` would be added to the `@param` Object, and `@return` to the @option's function.

I'm thinking of making it work by having any indentation of a `@tag` gets called with the "prev" data.

Ideally if descriptions were also indented like:

```
@function
@param {Object} options
param description

@option {function(String)} name(newName)
option description

@return {Boolean} true if successful.
return description

body
```

this could avoid needing a @body tag.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.