0
ответов
Как сослаться на задокументированный параметр функции Python с помощью разметки Sphinx?
Я хотел бы сослаться на ранее задокументированный параметр функции в другом месте строки документации Python. Рассмотрим следующий (по общему признанию, полностью искусственный) пример: def foo(bar): """Perform foo ...
вопрос задан: 8 February 2013 09:24
0
ответов
sphinx -сбой сборки -autodoc can& #39;t import/find module
Я пытаюсь начать работу со Sphinx и, похоже, постоянно испытываю проблемы. Команда :docs/sphinx -quickstart Отвечаю на все вопросы и все работает нормально. Команда :docs/ls Все выглядит...
вопрос задан: 8 February 2013 09:23
0
ответов
Что такое стандартный формат документации Python? [закрыто]
Я видел несколько разных стилей написания строк документации на Python, есть ли официальный или "согласованный" стиль?
вопрос задан: 7 February 2013 17:34
0
ответов
Какие новые функции (или будут )добавлены в Scaladoc в Scala 2.10? [закрыто]
Среди всех различных неполных списков функций, входящих в Scala 2.10, есть различные упоминания об улучшениях в Scaladoc. Но непонятно, какие есть, а какие на самом деле...
вопрос задан: 26 January 2013 08:55
0
ответов
VS2010: автоматически сгенерированный файл XML-документации не обновляется
У меня есть проект C # в vs2010, который генерирует файл XML-документации, в котором я установил путь вывода сгенерированного файла к пути вывода проекта. Моя проблема в том, что файл не обновляется ...
вопрос задан: 24 January 2013 13:53
0
ответов
Grails: альтернативы Grails Doc? [закрыто]
Документация, созданная с помощью Grails Doc, не совсем удовлетворительна для меня. Например, действия в контроллерах отображаются как свойства в документации, хотя я бы хотел ...
вопрос задан: 1 December 2012 22:57
0
ответов
Проблемы с запуском epstopdf. Проверьте вашу установку TeX
Я продолжаю получать следующую ошибку при запуске doxygen: Проблемы с запуском epstopdf. Проверьте вашу установку TeX! Нужно ли где-нибудь устанавливать латекс?
вопрос задан: 18 September 2012 20:03
0
ответов
Как собрать всего один файл с помощью sphinx
Для быстрого предварительного просмотра я хочу создать только один файл, а не весь проект. Можно со сфинксом? Недавно я сделал что-то вроде :sphinx -build -b html documentation/ doc _html спасибо
вопрос задан: 16 August 2012 22:19
0
ответов
как создать документацию API [закрыто]
Мне нужно написать документацию по API для REST API, который я создал. Существуют ли инструменты, которые будут заглушать хороший вывод html, похожий по стилю на документацию API с подчеркиванием? А может быть...
вопрос задан: 15 August 2012 12:49
0
ответов
Правильный способ обозначения типа данных массива для phpDocumentor?
Что из следующего является правильным способом документирования возвращаемого типа этого метода для phpDocumentor? Метод 1 :/***@return массив Массив Foo. */ публичная функция foo (){ возвращаемый массив (1, 2, 3 );...
вопрос задан: 9 August 2012 17:15
0
ответов
Группировка перегрузок в doxygen
В моей библиотеке много перегруженных функций вида :/// \brief Делает что-то. /// /// \details То, что сделано, очень особенное. шаблон<тип T> void do _stuff (const T& t );...
вопрос задан: 8 August 2012 08:39
0
ответов
Как использовать старый стиль/тему javadoc с JDK 7?
Мне трудно читать новую тему в JDK 7 для javadoc. Это может быть некрасиво, но я действительно предпочел бы старую тему. Помимо установки старых JDK и переключения между ними, можно ли как-то использовать...
вопрос задан: 7 August 2012 08:16
0
ответов
Документирование параметров Get/Post с помощью Doxygen или PHPDoc [закрыто]
Я просматривал документацию для PHPDoc и не смог найти хороший способ документировать переменные Post, которые я отправлял различным методам. Итак, я начал заглядывать в Doxygen с надеждой...
вопрос задан: 3 August 2012 14:35
0
ответов
комментирование функций обратного вызова
Просто любопытно, как можно прокомментировать, какие параметры будут переданы функции обратного вызова. Предположим, у нас есть следующий код и неполные комментарии /***совершенно бесполезная функция**...
вопрос задан: 3 August 2012 00:58
0
ответов
Как задокументировать мой метод на Java, как в документации по Java?
Я хочу, чтобы при наведении курсора на метод я мог видеть мою документацию о том, что делает этот метод, когда я навожу указатель мыши на метод Java. Я знаю, что /***/ как это делается, но :Как вы...
вопрос задан: 1 August 2012 16:45
0
ответов
Как поместить блоки кода PHP в DocBlock PHPDoc
Я играю с PHPDoc и понял, что вы можете использовать уценку, чтобы добавить форматирование в DocBlock. В частности, я заметил, что вы можете использовать обратные галочки для выделения встроенного кода. Однако...
вопрос задан: 31 July 2012 13:32
0
ответов
Какие типы документов необходимы для разработки программного обеспечения? [закрыто]
Я ознакомлен с документом о функциональных требованиях и документом с техническими спецификациями. Тем не менее, я хотел бы знать, какие документы необходимы для общей разработки проекта. Давайте...
вопрос задан: 30 July 2012 00:15
0
ответов
два или более типов данных в PHPdoc @param
хорошо, у меня есть этот phpdoc выше моего метода класса /***это функция, которая переводит текст *@param string|boolean $lang if string строка, указанная в параметре, будет кодом языка...
вопрос задан: 26 July 2012 05:46
0
ответов
Предупреждение во дворе с тегом @param
Я пытался задокументировать некоторый код Ruby, используя yardand, хотя я делаю именно то, что описано здесь или здесь #@param [Integer] количество испытаний (>= 0)
#@param [Float] успех...
вопрос задан: 3 July 2012 13:27
0
ответов
Использование Sphinx apidoc для создания документации из кода C++
В прошлом было несколько тем на эту тему, в которых утверждалось, что Sphinx вообще не поддерживает это. У меня были сомнения, но либо он был обновлен с тех пор, либо документация для него была довольно...
вопрос задан: 29 June 2012 16:53
0
ответов
Где определить номер версии приложения Rails [закрыто]
Существует ли соглашение о том, как/где указывать номер версии приложения? Например, для ruby gem обычно используется файл lib/mygem/version.rb. Мое предположение было бы...
вопрос задан: 26 June 2012 01:15
0
ответов
Существуют ли реальные альтернативы документации reStructuredText для Python? [закрыто]
В ближайшее время я начинаю проект Python с открытым исходным кодом и пытаюсь заранее решить, как писать свои строки документации. Очевидным ответом было бы использование reStructuredText и Sphinx с autodoc, потому что я...
вопрос задан: 24 June 2012 04:37
0
ответов
Как сделать перекрестную ссылку на уравнение в файле справки R / roxygen2
Я в процессе документирования некоторых моих функций для пакета R, который я создаю. Я использую разметку roxygen, хотя это в значительной степени не имеет отношения к моему вопросу. Я поместил уравнения в свой ...
вопрос задан: 22 June 2012 19:18
0
ответов
Как я могу заставить Hibernate размещать комментарии к таблицам/полям, которые он создает
Я хотел бы, чтобы Hibernate при создании DDL включал комментарии из моего исходного кода Java. Я был бы рад сделать это как аннотацию или как тег javadoc. ИОВ:
Я хотел бы иметь возможность пойти @Entity
@...
вопрос задан: 20 June 2012 03:46
0
ответов
Sandcastle не документирует сводки свойств
Сегодня я впервые использую SandCastle с графическим интерфейсом HelpBuilder, чтобы помочь создать API некоторых из наших доступных функций и свойств. Я включил /// ...
вопрос задан: 7 June 2012 20:00
0
ответов
Документирование функций сеттера с помощью roxygen
У меня есть функция, которая не делает ничего, кроме объявления уникального атрибута любому объекту R. Базовая демонстрация: # 'Функция установки
# '@param x объект R
# '@param value значение символа для установки
# '@export
`foo <-` & ...
вопрос задан: 7 June 2012 13:16
0
ответов
Sphinx и argparse - автодокументирование сценариев командной строки?
Я создаю пакет Python и использую Sphinx для создания документации. Помимо моего кода пакета, я также включаю множество скриптов командной строки Python, которые используют argparse. Мне интересно, есть ли...
вопрос задан: 6 June 2012 11:56
0
ответов
Совместное использование документов проекта в TFS различными способами, каковы ваши рекомендации? [закрыто]
Мне интересно, каковы ваши наилучшие методы управления (и управления версиями) различных типов проектных документов (например, управление версиями целевых документов, таких как: варианты использования, генеральный план тестирования, план обеспечения качес
вопрос задан: 1 June 2012 06:30
0
ответов
Как документировать блоки Objective-C с помощью doxygen?
Я работаю над проектом, основанным на документации doxygen, и не могу понять, как документировать блок. Давайте представим асинхронную функцию с блоком в качестве обратного вызова - (void)...
вопрос задан: 31 May 2012 09:13
0
ответов
Средство работы со строками документов в C++ [закрыто]
В таких языках, как Python, MATLAB, E-Lisp, есть это удобное средство для строк документов. С помощью этой функции, используя всего несколько нажатий клавиш в терминале, вы можете получить документацию по функциям / ...
вопрос задан: 28 May 2012 15:23