Bug 17911 - FR: build docs and package separately
: FR: build docs and package separately
Status: RESOLVED LATER
: Sisyphus
(All bugs in Sisyphus/mono-nunit22)
: unstable
: all Linux
: P2 minor
Assigned To:
:
:
:
:
:
  Show dependency tree
 
Reported: 2008-11-17 09:23 by
Modified: 2010-02-13 13:38 (History)


Attachments


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2008-11-17 09:23:52
Хорошо было бы иметь справочник NUnit, который генерится из кода. Формат
monodoc.
Кроме того, код nunit довольно хорошо документирован.
------- Comment #1 From 2008-11-17 14:29:10 -------
ок.
Ещё постараюсь сделать nunit-2.4.
------- Comment #2 From 2008-11-19 17:42:33 -------
просто пакет с html документацией я сделаю. А вот в формате monodoc нет. Если
раскажете как её сделать в этом формате - тогда сделаю.
------- Comment #3 From 2008-11-20 07:33:38 -------
man mdoc. Конкретного рецепта у меня нет, с наскоку я ман не одолел. Если пока
трудно, можно начать с html (не закрывая бага), поменяв на FR
------- Comment #4 From 2008-11-20 12:22:59 -------
mono-nunit22-2.2.10-alt2 с подпакетом doc в сизифе.
Дай знать, когда придумаешь как зделать доку в формате monodoc. Аналогичные
пакеты ещё есть. Кроме этого, ещё есть пакеты использующие mono-ndoc. Конечно
хорошобы всю документацию иметь единую в monodoc.
------- Comment #5 From 2009-09-11 00:51:09 -------
(В ответ на комментарий №4)
> Дай знать, когда придумаешь как сделать доку в формате monodoc. Аналогичные пакеты ещё есть.

Оказалось всё довольно нетрудно.
1. mcs -doc:/tmp/incode.docs.xml *.cs
    создаёт файл xml с документацией
2. mdoc-update -i /tmp/incode.docs.xml
/usr/lib/mono/1.0/nunit.core.interfaces.dll --out .
    создаёт (или обновляет) документацию на DLL с учётом того xml, который был
создан ранее.

Глядя в сам NUnit, я не нашёл цели для NAnt Build, чтобы создать документацию.
ИМХО надо связаться с апстримом, чтобы они добавили. Я, пожалуй, могу этим
заняться (или ты займись).
Пока же можно прохакать файлы *.build, чтобы параллельно с компиляцией,
создавался (или создавались) файл документации xml.
Справишься?

> Кроме этого, ещё есть пакеты использующие mono-ndoc. Конечно
> хорошо бы всю документацию иметь единую в monodoc.

я посмотрю ndoc. А ты, пожалуйста, уточни: какие пакеты используют ndoc-доки.
------- Comment #6 From 2010-02-13 13:38:33 -------
http://sourceforge.net/tracker/?func=detail&atid=360749&aid=2857669&group_id=10749

Апстрим молчит, поэтому закрываю с LATER