问题标签 [grunt-ngdocs]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
275 浏览

ngdoc - grunt-ngdocs:样式文件不包含在演示代码中

grunt-ngdocs用来记录我的 Angular 项目。但是演示 Plunker 代码(自动生成)不包含 CSS 文件。

我的配置Gruntfile.js包括:

在我的 JS src 文件中:

在 API 页面上,正确加载了 JS 和 CSS 文件。但是显示的demo源代码不包括 CSS 文件:

在我的 API 页面上,演示运行良好。但是链接到 Plunker 不会产生预期的结果,因为不存在包含行的 CSS。有什么建议么?

0 投票
1 回答
873 浏览

javascript - AngularJs ngdocs:注释一个方法返回一个promise

我目前正在记录我的第一个真正的 AngularJs 应用程序,因为我正在使用带有 grunt-ngdocs 的 ngdocs 语法

我想知道是否有更好的方法来注释我的服务方法返回一个承诺(所以你知道你应该附加一个 .then() 而不是访问返回对象。

服务的完整上下文:

0 投票
1 回答
363 浏览

javascript - grunt-ngdoc 没有为我的 ngdoc 文档呈现示例

我正在尝试为我的 Angular 项目使用 ngDoc 获得一个基本示例。

这是一个例子:

编译文档时会显示示例标题,但没有嵌入示例。

这是编译文档的链接:

http://thinkingmedia.github.io/thinkingmedia-ui/#/api/ui.components.uiRepeat

这是 Angular 文档的链接,显示了示例的外观:

https://docs.angularjs.org/api/ng/directive/ngClick

我不知道我的 ngDoc 有什么问题?

0 投票
1 回答
553 浏览

angularjs - ngdocs - 如何为现场演示示例添加样式

我想将我的 css 样式表添加到 ngdocs 文档中的实时演示示例中。

我希望样式影响演示本身,但显然,它们不应该影响整个网页。

我尝试将我的样式表添加到 gruntfile ngdocs 选项中,如下所示:

这确实将 mylayout.css 作为链接标记添加到 index.html 的标记中,作为 head 部分中最后包含的链接标记,但其中的样式会覆盖整个页面上的样式。不好。

我该怎么做才能使我的样式在现场演示中起作用,但在页面的其余部分不起作用?

谢谢你的帮助!希望这将对 ng-docs 上非常有限的可用信息做出贡献!

编辑:我最终做的是创建一个名为 myNgdocsLayout.css 的新 css 文件,我在其中编写了几个覆盖 mylayout.css 的样式,同时仍然允许 mylayout.css 样式应用于现场演示。

现在我的页面看起来不错,但这绝对不是一个完美的解决方案。如果有人能提出一个想法,让我的样式仅适用于我的现场演示,而无需在页面的其余部分覆盖它们,我仍然会很感激......如果没有构建我会感到惊讶- 在 ngdocs 中这样做。

0 投票
1 回答
196 浏览

angularjs - angularjs 通过 grunt 和 ngdocs 创建文档

您好,我正在尝试通过 grunt 和 ngdoc 为我的 ionicframework/angularjs 应用程序创建文档。

我已经在http://gruntjs.com/getting-started中安装了所有喜欢的东西

好吧,如果我现在运行 grunt

我得到:

而且我无法显示文档。

我的 gruntfile 看起来像这样:

我是为 angularjs 创建文档的新手,那么为此目的的最佳实践是什么?

0 投票
3 回答
2686 浏览

javascript - 控制器的 ngdoc 文档

我是代码文档的新手,并试图用 grunt-ngdocs 记录我的角度应用程序。

我从以下位置克隆了一个工作示例:https ://github.com/m7r/grunt-ngdocs-example

给定的示例缺少文档控制器,因此我使用以下代码添加了自己的文档控制器:

当我尝试通过从命令行运行 grunt 来构建文档时,我收到以下错误消息:

我该如何解决?我阅读了本指南http://www.shristitechlabs.com/adding-automatic-documentation-for-angularjs-apps/,但我不明白为什么我尝试记录控制器时会不断收到错误消息:(谢谢寻求帮助!

0 投票
1 回答
1193 浏览

angularjs - 在angularJS中使用带有控制器属性的ngdocs

我刚刚开始掌握在我的角度应用程序中使用 grunt-ngdocs 并且到目前为止一切都很好。

但是我现在想在我的一个控制器中记录另一个记录的属性的一些属性。

考虑以下代码:

如您所见,我有一些挂在 vm 变量上的属性,这些属性通常是对控制器中定义的函数的引用。

使用上面的 ngdocs\jsdocs 文档语法,我可以将 vm 属性输出到我的文档文件夹中,但我不确定如何记录 vm 对象本身的属性。

有没有明智或推荐的方法来做到这一点?我确实想知道不完全记录 vm 而只是分别记录每个 vm.xxx,但我对此不太确定!

谢谢

0 投票
1 回答
977 浏览

angularjs - ngdocs - 如何记录模块配置和运行块

我最近开始在我的 Angular 应用程序中使用 ngdocs,我对如何合理地记录模块配置和运行块感到困惑。

我目前有这个:

它按预期在文档中输出模块 app.core 。但是如何记录运行块?我正在努力寻找任何例子。

谢谢

0 投票
0 回答
603 浏览

javascript - 使用自定义指令创建 ngdocs 示例

您好,我正在尝试使用 grunt-ngdocs 为指令创建一个示例:https ://github.com/m7r/grunt-ngdocs

示例标签的文档非常差,所以我无法在 ng-docs 和 plnkr 中创建一个工作示例。

我的示例如下所示:

该指令在运行时效果很好,问题只是为我编写的软件的文档创建一个示例。

plnkr 在这里:

http://plnkr.co/edit/2ZnWoCAyRPfEzPJ07Qph?p=preview

0 投票
0 回答
180 浏览

angularjs - 如果我添加角度材料作为依赖项,ngdoc 示例块不起作用

下面是我的 grunt ngdocs 任务。

我的 ngdoc 示例块是从 Angular 文档中复制的。我刚刚添加了“ngMaterial”作为依赖项。

以下是我得到的错误。

如果我将 'ngMaterial' 作为依赖项删除,则此示例块绝对可以正常工作。我正在使用 Angular 1.4.3 和 Angular-material 1.0.5。请帮忙。