Результаты поиска по запросу "documentation"

1 ответ

Не понимаю, почему этот ответ не имеет больше голосов.

оложим, что в рамках документирования вашего кода (Javadoc) вы хотите указать, что в отношениях между элементами используется глубокий отступ. Как я могу создать вложенный список как: какой-то элементкакой-то другой элементеще какой-то другой ...

1 ответ

Как показать атрибуты экземпляра в Sphinx Doc?

Есть ли способ, как автоматически показывать переменныеvar1а такжеvar2и их значения init в документации sphinx? class MyClass: """ Description for class """ def __init__(self, par1, par2): self.var1 = par1 * 2 self.var2 = par2 * 2 def ...

1 ответ

Нужно ли экспортировать расширения базовых методов в R-пакет? Последствия для документации?

В принципе, я мог бы сохранить эти расширения неэкспортированными, и это также позволило бы мне не добавлять избыточную документацию для этих уже хорошо документированных методов, в то же время передаваяR CMD check myPackage без каких-либо ...

ТОП публикаций

1 ответ

Doxygen и добавьте значение атрибута в выходную документацию

ServiceStack [http://servicestack.net]отмечает пути покоя для веб-сервисов, используя атрибуты c #. Например [RestService("/hello1")] [RestService("/hello2")] public class HelloЯ хотел бы, чтобы Doxygen включал значения атрибута RestService в ...

1 ответ

Существует ли «вики» для редактирования комментариев doxygen? [закрыто]

Я работаю над довольно большим игровым движком с открытым исходным кодом RTS ( весна [http://springrts.com/]). Недавно я добавил несколько новых функций C ++, вызываемых Lua, и мне интересно, как лучше их документировать, и в то же ...

1 ответ

Сообщения об ошибках GNU C ++ [закрыто]

Есть ли в сети полный список сообщений об ошибках / предупреждений для компилятора g ++? Я ищу что-то похожее на документацию MSDN, которая описывает, что означает каждое сообщение, и, возможно, содержит некоторый пример кода, ...

1 ответ

Документирование закрытия функций

Предположим, у меня есть закрытие функции в моем пакете, например f = function(x) { x = x g = function(y) x <<- y h = function() x list(g = g, h = h) } l = f(5) l$g(10) l$h()Что правильно (в официальномCRAN [http://cran.r-project.org/]смысл) ...

1 ответ

Документирование макросов Scala 2.10 [закрыто]

Начну с примера. Вот эквивалентList.fill для кортежей в качестве макроса в Scala 2.10: import scala.language.experimental.macros import scala.reflect.macros.Context object TupleExample { def fill[A](arity: Int)(a: A): Product = ...

1 ответ

Doxygen: групповые модули и страницы?

У меня есть вопрос о страницах и группах в Doxygen. У меня есть проект, где я сгруппировал классы и т. Д. С@defgroup а также@в группе CMDS. Пока это работает нормально. Теперь я хотел бы добавить в проект специальную документацию со ...

1 ответ

Использование исходных подкаталогов в R-пакетах с roxygen2

Я хотел бы использовать структуру каталогов внутриR папка для исходного кода пакета. Например, в моемR папка у меня естьalgos папка с функциями, которые я хочу экспортировать и документ. тем не мениеroxygen2 по умолчанию не проходит через ...