Кто в чем пишет документацию на ПО?

noweb

Где можно почитать примеры ваших сорцов?

А чем извлекаешь докстринги из исходников в печатную документацию?

Для CL есть тулсы ;) я пользуюсь http://weitz.de/documentation-template/ — выводит в HTML. Но ни разу не приходилось делать бумажную документацию на API.

Но ни разу не приходилось делать бумажную документацию на API.

Ну, я имею в виду электронную версию, но пригодную к распчатке (т.е. не вывод Doxygen).

Word оно конечно какашка , однако кто пишет на ассемблере тот сам битики(поинты) считает.

к Word'у прикручиваете нужные вам макросы и дышать становится легче.

единовременное - да адь и луизина.

Я, помнится, как-то боролся пару дней с доксигеном... оказалось все проектные дефайны надо дефайнить в конфиге доксигена.... Самое смешное что нигде об этом не написано, вроде как само собой разумеющееся действие...

http://ru.wikipedia.org/wiki/ReStructuredText , http://en.wikipedia.org/wiki/Lout_(software)

Можно еще к pandoc присмотреться: есть например такая обертка http://www.unexpected-vortices.com/sw/gouda/

Кроме doxygen универсальный - http://www.naturaldocs.org/ , sphinx вроде хвалят (там как раз python & c/c++). // не пробовал - смотрите сами

ты это я

единовременное - да адь и луизина.

А не единовременное - диагноз.

А чем извлекаешь докстринги из исходников в печатную документацию?

Была такая ботва, что то вроде pydoc... сейчас уже не помню.

не похоже это на правду. я в конце 90х сам лично делал эти ваши курсачи и дипломники в ворде, и все там было ок. и картинки и таблички и формулы ок встраивались из маткада

может дело в руках?

На моем локалхосте :)

Для вёрда нужен экзамен типа CCNA :D

В конце 90-х у ворда документы вечно сыпались. Одно неосторожное движение - и прощай документ. Симптомы сохранились и по сей день, хотя не такие острые.

В этом смысле Framemaker выглядел как оплот стабильности еще в тех 90-х. Вот это была действительно надежная программа. Жаль, что продалась адобу.

в OOWriter и OODraw.

и очень нехватает возможности вставить картинку в код в виде комента.

потому что скольнибудь серьезный код без графического описания понять сложно. например, это упорядоченный контейнер, заточеный на работу с SMP:

map<X,Y> с операциями забрать элемент c минимальным X если X<Xmin, удалить элемент с заданным Y, вставить (X,Y).

не очень представляю, как это понять без картинки

sphinx + rst2pdf.pdfbuilder

Картинки в код --- для этого всякие web-штуки предназначены.

У нас формулы рисуют в автокаде и вставляют в виде картинок.

Я хз, но форматирования постоянно сбивается.

к Word'у прикручиваете нужные вам макросы и дышать становится легче.

~60% документации, которую я оформлял, можно автоматически сгенерить из doc-комментов. Чем мне помогут макросы ворда - они будут выдергивать комментарии из исходника и вставлять в документ? Ну и главное - в результате всего ворд-фу получаем фактичеси двоичный файл, который нормальному diff и merge не поддается. Вот это и есть луизина.

формулы рисуют в автокаде

facepalm.jopeg

Угу.

На ПО у меня сейчас актуально написание man-страничек и texinfo. Другие отчеты (работа по железу) пишу в TeX.

org-mode.

Для CL есть тулсы ;) я пользуюсь http://weitz.de/documentation-template/ — выводит в HTML. Но ни разу не приходилось делать бумажную документацию на API.

Все, кстати, руки не доходят поглядеть на excribe

LOR просто какое-то гнездо техников.

vim, mcedit, -> OpenOffice(PDF)

doxygen и wiki

Поскольку я ленив и разбираться в настройках не хочу, то пишу ручками в LaTeX

Ты не только ленив, но еще и изврашенец :) Говорю тебе как doxygen-осилятор.

Говорю тебе как doxygen-осилятор.

Если ты осилятор doxygen, скажи, как заставить его выдать просто линейный список документированных функций? Я не хочу диаграмм модулей, ничего такого - просто единый файл.

А на нем можно курсовичек оформить?
Или он только для доков?

не знаю что такое куросовичек. я кроме доков использовал для оформления перевода документации к Exim

Ясно

Если ты осилятор doxygen, скажи, как заставить его выдать просто линейный список документированных функций? Я не хочу диаграмм модулей, ничего такого - просто единый файл.

в doxywizard-е прото убираешь ненужные чекбоксы :)

как заставить его выдать просто линейный список документированных функций? Я не хочу диаграмм модулей, ничего такого - просто единый файл.

в doxywizard-е прото убираешь ненужные чекбоксы :)

...или убираешь ненужные настройки в конфигурационном файле. Вопрос только в том, какие именно настройки.

Впрочем, спрошу прямо: ты сам-то это делал?

какбе да

И какие же настройки нужно убрать?

вы просто не умеете его готовить. я диплом в ворде делал, рамки втыкаются в колонтитулы (нашел где-то более менее адекватный шаблон) и дальше разницы с обычным документом никакой

doxygen для JS не подходит

ЩИТО?

org-mode.

org-babel или вики с TODO list в голом org-mode?

С babel конечно.

официально поддерживается? нет.

Ну, сделай свой вид (layout), без navindex, без пространств имен, без классов, без групп, только файло + генерацию в к-л текс или пдф.

Да ладно тебе :) Вон, на макросах ворда вирусы пишут - не то что пошлый парсинг комментариев :)

public confluence + javadoc

Ну, сделай свой вид (layout), без navindex, без пространств имен, без классов, без групп

Это точно делаетя чекбоксами в doxywizard?

Не знаю :)

Свой велосипед.