Bug 17911 - FR: build docs and package separately
Summary: FR: build docs and package separately
Status: CLOSED WONTFIX
Alias: None
Product: Sisyphus
Classification: Development
Component: mono-nunit22 (show other bugs)
Version: unstable
Hardware: all Linux
: P2 minor
Assignee: ildar
QA Contact: qa-sisyphus
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-11-17 09:23 MSK by ildar
Modified: 2018-04-18 09:45 MSK (History)
4 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description ildar 2008-11-17 09:23:52 MSK 
Хорошо было бы иметь справочник NUnit, который генерится из кода. Формат monodoc.
Кроме того, код nunit довольно хорошо документирован.
Comment 1 Alexey Shabalin 2008-11-17 14:29:10 MSK 
ок.
Ещё постараюсь сделать nunit-2.4.
Comment 2 Alexey Shabalin 2008-11-19 17:42:33 MSK 
просто пакет с html документацией я сделаю. А вот в формате monodoc нет. Если раскажете как её сделать в этом формате - тогда сделаю.
Comment 3 ildar 2008-11-20 07:33:38 MSK 
man mdoc. Конкретного рецепта у меня нет, с наскоку я ман не одолел. Если пока трудно, можно начать с html (не закрывая бага), поменяв на FR
Comment 4 Alexey Shabalin 2008-11-20 12:22:59 MSK 
mono-nunit22-2.2.10-alt2 с подпакетом doc в сизифе.
Дай знать, когда придумаешь как зделать доку в формате monodoc. Аналогичные пакеты ещё есть. Кроме этого, ещё есть пакеты использующие mono-ndoc. Конечно хорошобы всю документацию иметь единую в monodoc.
Comment 5 ildar 2009-09-11 00:51:09 MSD 
(В ответ на комментарий №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 ildar 2010-02-13 13:38:33 MSK 
http://sourceforge.net/tracker/?func=detail&atid=360749&aid=2857669&group_id=10749

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