Есть ли способ исключить функции и элементы уровня пакета из вывода Doxygen?

Я работаю с Doxygen на рабочем месте, и у меня проблема с кодом Java. При EXTRACT_ALL=NO, EXTRACT_PRIVATE=NO, EXTRACT_STATIC=NO, EXTRACT_LOCAL_CLASSES=NO и EXTRACT_LOCAL_METHODS=NO выходные данные по-прежнему включают статические элементы, которые не определены как общедоступные или частные.

БЫВШИЙ. Допустим, у меня есть следующий код:

class EXAMPLE{

public static func1()

private static func2()

static func3()

}

func3 определяется только как static, потому что это функция уровня пакета.

func1 и func3 отображаются в выводе, и я хочу, чтобы отображалось только func1.

Кто-нибудь знает способ показать только те функции, которые явно определены как общедоступные?

Заранее спасибо.


person Community    schedule 19.06.2009    source источник


Ответы (2)


Вы можете поместить материал, который вы не хотите видеть в выводе doxygen, внутри блока \cond ... \endcond:

class EXAMPLE{

public static func1()

/// \cond

private static func2()
static func3()

/// \endcond

}
person mouviciel    schedule 13.07.2009
comment
Спасибо за ответ, но у меня немного сложнее. Скажем, то, что я не хочу показывать, тщательно перемешано с тем, что я хочу показать. Например, любая другая функция объявляется только как статическая. Использование этих блоков \cond очень быстро станет очень утомительным. Я больше смотрю на то, чтобы иметь возможность изменять свойства в файле конфигурации, не запутывая код дополнительными комментариями, необходимыми только для инструмента. - person ; 13.07.2009

Разработка новых фильтров для Doxygen (HTML, XSLT, BAT..., см. https://github.com/msillano/filters_dox) Я создаю множество псевдофункций с одинаковыми именами. Страницы файлов в порядке, но это делает страницы «Члены файла/все» и «Члены файла/Функции» без всякого интереса. В Doxygen-config нельзя исключить создание этих страниц (позор). Я нашел обходной путь для вывода HTML (в версии 1.8.15).

  • Установите для эксперта/HTML/HTML_DYNAMIC_MENUS значение «да».
  • Создайте документацию.
  • Отредактируйте файлы «navtreedata.js» (для древовидного меню) и «menudata.js» (для меню вкладок). Используя редактор с «совпадением скобок», легко удалить все элементы после «Списка файлов».

Не элегантно, но работает.

person msillano    schedule 16.02.2019