Как отделить документ API от внутреннего документа функций в JSDOC

Question

У меня есть два файла.js, который представляет один модуль. Этот модуль будет представлять API для использования с другими модулями, поэтому я хочу хорошо документировать этот API.

Вот структура файлов и функций:

file1.js
    // Include these functions
    getCLO();      // Should appear in API doc view
    addCLO();      // Should appear in API doc view
    prepareCL();   // Should appear in internal module doc view not in API view

file2.js
    // Include these functions
    getLM();       // Should appear in API doc view
    addLM();       // Should appear in API doc view
    prepareLM();   // Should appear in internal module doc view not in API view

Когда я использую JSDOC, я получаю все функции в разделе Global, что хорошо для внутреннего модуля doc. Но как выбрать некоторые функции для документирования в представлении API и как их сгенерировать?

Answer 1

Вы можете использовать @private или @access, чтобы контролировать, какие функции генерируются