热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

Issuewith@nameAnnotationinDocumentationGeneration

Thispostdiscussesanissueencounteredwhileusingthe@nameannotationindocumentationgeneration,specificallyregardingnestedclassprocessingandunexpectedoutput.

If you're reporting a bug, please provide input code, expected output, and actual output. This will help diagnose the problem more effectively.

I've been reviewing the documentation and searching through issues to find a solution to my problem. The issue revolves around nested classes being processed when they shouldn't be.

Consider the following example:

/**
* Emission settings
*/
export default class Emission {
constructor(params) {
_create(params);
}

/**
* Creates panel on the emission
* @param {object|array} emission
*/
_create(params) {
let panel = new Panel();
}
}

I expected the generated Markdown file (emission.md) to look like this:

## Emission

Emission settings

### _create

Creates panel on the emission

**Parameters**

- `emission` **[object](https://developer.mozilla.org/docs/Web/Javascript/Reference/Global_Objects/Object), [array](https://developer.mozilla.org/docs/Web/Javascript/Reference/Global_Objects/Array)**

However, the actual output includes additional sections that I did not anticipate:

## Emission

Emission settings

### _create

Creates panel on the emission

**Parameters**

- `emission` **[object](https://developer.mozilla.org/docs/Web/Javascript/Reference/Global_Objects/Object), [array](https://developer.mozilla.org/docs/Web/Javascript/Reference/Global_Objects/Array)**

## Panel

**Extends PanelCore**

I have spent hours trying to resolve this issue...

Here are my gulp settings:

gulp.task('docs', () => {
return gulp.src('./js/*.js')
.pipe(flatmap((stream, file) => {
console.log(file.path);
return gulp.src(file.path)
.pipe(docs('md',{ecmaVersion: 6, sourceType: 'module', filename: file.path.split('/').pop().split('.')[0] + '.md' }))
.pipe(gulp.dest('WebOs.wiki/ds'));
}));
});
  • documentation.js version: 5.4.0
  • How are you running documentation.js: "gulp-documentation": "^3.2.1"

This issue comes from the open-source project: documentationjs/documentation.

Apologies for any inconvenience caused by this query. Thank you for your assistance!


推荐阅读
  • 本文深入探讨了 Java 中的 Serializable 接口,解释了其实现机制、用途及注意事项,帮助开发者更好地理解和使用序列化功能。 ... [详细]
  • XNA 3.0 游戏编程:从 XML 文件加载数据
    本文介绍如何在 XNA 3.0 游戏项目中从 XML 文件加载数据。我们将探讨如何将 XML 数据序列化为二进制文件,并通过内容管道加载到游戏中。此外,还会涉及自定义类型读取器和写入器的实现。 ... [详细]
  • UNP 第9章:主机名与地址转换
    本章探讨了用于在主机名和数值地址之间进行转换的函数,如gethostbyname和gethostbyaddr。此外,还介绍了getservbyname和getservbyport函数,用于在服务器名和端口号之间进行转换。 ... [详细]
  • 扫描线三巨头 hdu1928hdu 1255  hdu 1542 [POJ 1151]
    学习链接:http:blog.csdn.netlwt36articledetails48908031学习扫描线主要学习的是一种扫描的思想,后期可以求解很 ... [详细]
  • 火星商店问题:线段树分治与持久化Trie树的应用
    本题涉及编号为1至n的火星商店,每个商店有一个永久商品价值v。操作包括每天在指定商店增加一个新商品,以及查询某段时间内某些商店中所有商品(含永久商品)与给定密码值的最大异或结果。通过线段树分治和持久化Trie树来高效解决此问题。 ... [详细]
  • DNN Community 和 Professional 版本的主要差异
    本文详细解析了 DotNetNuke (DNN) 的两种主要版本:Community 和 Professional。通过对比两者的功能和附加组件,帮助用户选择最适合其需求的版本。 ... [详细]
  • 本文探讨了如何在模运算下高效计算组合数C(n, m),并详细介绍了乘法逆元的应用。通过扩展欧几里得算法求解乘法逆元,从而实现除法取余的计算。 ... [详细]
  • 本文详细介绍了 Apache Jena 库中的 Txn.executeWrite 方法,通过多个实际代码示例展示了其在不同场景下的应用,帮助开发者更好地理解和使用该方法。 ... [详细]
  • 使用Vultr云服务器和Namesilo域名搭建个人网站
    本文详细介绍了如何通过Vultr云服务器和Namesilo域名搭建一个功能齐全的个人网站,包括购买、配置服务器以及绑定域名的具体步骤。文章还提供了详细的命令行操作指南,帮助读者顺利完成建站过程。 ... [详细]
  • 本题探讨如何通过最大流算法解决农场排水系统的设计问题。题目要求计算从水源点到汇合点的最大水流速率,使用经典的EK(Edmonds-Karp)和Dinic算法进行求解。 ... [详细]
  • 本文探讨了如何在给定整数N的情况下,找到两个不同的整数a和b,使得它们的和最大,并且满足特定的数学条件。 ... [详细]
  • This document outlines the recommended naming conventions for HTML attributes in Fast Components, focusing on readability and consistency with existing standards. ... [详细]
  • Splay Tree 区间操作优化
    本文详细介绍了使用Splay Tree进行区间操作的实现方法,包括插入、删除、修改、翻转和求和等操作。通过这些操作,可以高效地处理动态序列问题,并且代码实现具有一定的挑战性,有助于编程能力的提升。 ... [详细]
  • 题目Link题目学习link1题目学习link2题目学习link3%%%受益匪浅!-----&# ... [详细]
  • 本文详细介绍了C语言中链表的两种动态创建方法——头插法和尾插法,包括具体的实现代码和运行示例。通过这些内容,读者可以更好地理解和掌握链表的基本操作。 ... [详细]
author-avatar
mobiledu2502925687
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有