如何在不同部分的模块之间建立链接

时间:2014-08-15 15:04:32

标签: javascript angularjs angularjs-directive documentation gruntjs

如下所示,我在Grunfile.js的ngdocs设置中定义了两个部分:

ngdocs: {
  options: {
    dest: 'docs',
    html5Mode: false,
    ....
  },
  api: {
    src: ['src/lib/*.js'],
    title: 'Libraries'
  },
  app: {
    src: ['src/app/*.js'],
    title: 'Application'
  }
},

如何通过@link指令连接这些模块?如果您构建示例,您将看到src / app / main.js模块(MainModule)与src/lib/notification.js模块(NotificationsModule)之间的所有链接都被破坏:(

项目问题#98(https://github.com/m7r/grunt-ngdocs/issues/98)重复了这个问题。

2 个答案:

答案 0 :(得分:2)

添加模块名称作为前缀解决问题!这意味着

/**
 * @ngdoc function
 * @name MainModule.NotifyCtrl
 * @requires $scope
 * @requires api/NotifyModule.NotificationsService

非常感谢。

答案 1 :(得分:1)

我不确定我是否理解你的问题,但在为我的服务编写文档时,我发现要链接到文档其他部分的文档,需要使用以下格式:

@ngdoc service
@name app.module.servicename
@requires app.module.anotherService
@requires app.module2.anotherServiceInApp
@requires ./api/api.serviceModule.serviceInApiModule

请注意您需要使用相对路径从应用文档获取到api文档