Как отделить документ API до внутренних функций doc в 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 я получить все функции в глобальной секции, которые будут хороши для внутреннего модуля док. Но как выбрать некоторые функции для документирования в представлении API и как его создать?

Answer 1

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