Doxygen - История изменений

Korogodin в 17:40, 19 апреля 2011

2011-04-19T17:40:05Z

Korogodin: /* Bug, ToDo, Warning, Note */

2011-04-19T17:35:43Z

‎Bug, ToDo, Warning, Note

Korogodin: /* Bug, ToDo, Warning, Note */

2011-04-19T17:35:16Z

‎Bug, ToDo, Warning, Note

Korogodin в 17:33, 19 апреля 2011

2011-04-19T17:33:15Z

Korogodin: /* Востребованные команды */

2011-04-19T17:32:26Z

‎Востребованные команды

Korogodin в 17:26, 19 апреля 2011

2011-04-19T17:26:44Z

Korogodin: /* Документирование функции */

2011-04-19T17:24:33Z

‎Документирование функции

Korogodin: /* Документирование структур, переменных и т.д. */

2011-04-19T17:22:58Z

‎Документирование структур, переменных и т.д.

Korogodin в 17:19, 19 апреля 2011

2011-04-19T17:19:55Z

Korogodin: /* Пример из жизни */

2011-04-19T17:15:31Z

‎Пример из жизни

← Предыдущая		Версия 17:40, 19 апреля 2011
Строка 2163:		Строка 2163:
	</div>		</div>
	</div>		</div>
		+
		+
		+	== Проблемы ==
		+
		+	Doxygen, во всяком случае мой, некорректно работает с директивами препроцессора <code>#if, #ifdef</code> и т.п. Пока удается решить эту проблему перечислением в Doxyfile (поле PREDEFINED) значений всех используемых в таких выражениях define'ов.

@@ Строка 1498: / Строка 1498: @@
 <source lang="c">
 @warning Не трогать значение этой переменной
 @todo Переписать функцию под новую структуру данных
 @bug Ошибочно работает при x<0
 @note Подробнее изложено в рабочем журнале
 </source>

← Предыдущая		Версия 17:35, 19 апреля 2011
Строка 1497:		Строка 1497:
	Одноименные команды вставляют одноименные заметки. Далее doxygen формирует отдельные списки, по которым можно быстро найти интересующее место в коде.		Одноименные команды вставляют одноименные заметки. Далее doxygen формирует отдельные списки, по которым можно быстро найти интересующее место в коде.

		+	<source lang="c">
		+	@warning Не трогать значение этой переменной
		+	@todo Переписать функцию под новую структуру данных
		+	@bug Ошибочно работает при x<0
		+	@note Подробнее изложено в рабочем журнале
		+	</source>

	== Пример из жизни ==		== Пример из жизни ==

← Предыдущая		Версия 17:33, 19 апреля 2011
Строка 1496:		Строка 1496:

	Одноименные команды вставляют одноименные заметки. Далее doxygen формирует отдельные списки, по которым можно быстро найти интересующее место в коде.		Одноименные команды вставляют одноименные заметки. Далее doxygen формирует отдельные списки, по которым можно быстро найти интересующее место в коде.
		+

	== Пример из жизни ==		== Пример из жизни ==

← Предыдущая		Версия 17:32, 19 апреля 2011
Строка 1493:		Строка 1493:


		+	=== Bug, ToDo, Warning, Note ===
		+
		+	Одноименные команды вставляют одноименные заметки. Далее doxygen формирует отдельные списки, по которым можно быстро найти интересующее место в коде.

	== Пример из жизни ==		== Пример из жизни ==

@@ Строка 8: / Строка 8: @@
 Doxygen - консольная программа в духе классической Unix. Она работает подобно компилятору, анализируя исходные тексты и создавая документацию.
 == Что требуется установить для полноценной работы ==
 === Doxygen ===
 Основная программа
 === Graphiz ===
 [http://ru.wikipedia.org/wiki/Graphviz Graphviz] – это свободно распространяемый пакет утилит для визуализации данных. Нам он нужен для того, чтобы Doxygen мог показать в документации отношения наследования, графы вызовов и прочую информацию в виде наглядных изображений.
 === LaTeX ===
 При установленном пакете того или иного LaTeX-дистрибутива, Doxygen конвертирует TeX-разметку в комментариях в изображения, а затем вставляет их в итоговый отчет. Также генерирует TeX-файлы, а затем PDF.
 === Doxywizard ===
@@ Строка 1418: / Строка 1423: @@
   \interface - документирование IDL интерфейса
   \package - документирование пакета на языке Java
 == Востребованные команды ==
-=== Документирование структур, переменных и т.д. ===
 Переменные часто удобно объединять в группы:
@@ Строка 1437: / Строка 1444: @@
 </source>
-=== Документирование функции ===
 <source lang="c">
@@ Строка 1456: / Строка 1464: @@
+}
 </source>
 === Вставка TeX-формул ===
 Для вставки TeX-формулы используются команды <code>\f$ ... \f$</code> и <code>\f[ ... \f] </code>, которые обрамляют TeX-разметку:
 Выражение в тексте:
@@ Строка 1483: / Строка 1491: @@
 EXTRA_PACKAGES         = amssymb,amsfonts,amsmath,mathtext
 </source>
@@ Строка 2142: / Строка 2151: @@
    </div>
 </div>
 == Ссылки ==

← Предыдущая		Версия 17:24, 19 апреля 2011
Строка 1438:		Строка 1438:

	=== Документирование функции ===		=== Документирование функции ===
		+
		+	<source lang="c">
		+	/**
		+	Позволяет установить оценку дисперсии (мощности шумовой составляющей) корреляционных сумм и
		+	зафиксировать её.
		+	@param PoMe - указатель на структуру данных блока оценки с/ш
		+	@param stdn2_IQ - устанавливаемое значение оценки дисперсии квадратур
		+	@return 0, если прошло успешно, 1, если предлагаемое число после сдвига не влазиет в 32 разряда
		+	*/
		+	int SetVariancePowerMeasure(PowerMeasure_struct *PoMe, quint32 stdn2_IQ ){
		+	if (__CLZ(stdn2_IQ) >= x_stdn2_shift){ // Если предлагаемое число можно сдвинуть, не переполнив 32 разряда
		+	PoMe->x_stdn2_est = stdn2_IQ;
		+	// В случае увеличения порядка фильтра добавить сюда PoMe->x_stdn2_extr = stdn2_IQ;
		+	PoMe->x_stdn2_est_shifted = stdn2_IQ<<x_stdn2_shift;
		+	return 0;
		+	}else return 1;
		+	}
		+	</source>

	=== Вставка TeX-формул ===		=== Вставка TeX-формул ===

← Предыдущая		Версия 17:22, 19 апреля 2011
Строка 1422:		Строка 1422:

	=== Документирование структур, переменных и т.д. ===		=== Документирование структур, переменных и т.д. ===
		+
		+	Переменные часто удобно объединять в группы:
		+	<source lang="c">
		+	/** @name Аккумуляторы и их триггеры */
		+	quint32 R2; ///< Первичный акк. \f$ I^2 + Q^2 \f$
		+	quint64 R4; ///< Первичный акк. \f$ (I^2 + Q^2)^2 \f$
		+
		+	quint32 R2_acum; ///< Вторичный аккумулятор R2
		+	quint64 R4_acum; ///< Вторичный аккумулятор R4
		+
		+	quint32 R2_acum_copy; ///< Триггер R2_acum
		+	quint64 R4_acum_copy; ///< Триггер R4_acum
		+	//@}
		+	</source>

	=== Документирование функции ===		=== Документирование функции ===

@@ Строка 7: / Строка 7: @@
 Для html-представления документации, размещаемого на web-серверах, существует удобный способ организации поиска (при помощи создаваемого Doxygen'ом PHP-модуля) и ссылок на внешнюю документацию.
-Doxygen - консольная программа в духе классической Unix. Она работает подобно компилятору, анализируя исходные тексты и создавая документацию. [ Пример.]
+Doxygen - консольная программа в духе классической Unix. Она работает подобно компилятору, анализируя исходные тексты и создавая документацию.
 == Что требуется установить для полноценной работы ==

@@ Строка 1455: / Строка 1455: @@
 == Пример из жизни ==
-Пример документирования файлов PowerMeasure.c и PowerMeasure.h
+Пример документирования файлов PowerMeasure.c и PowerMeasure.h. Результат можно подглядеть [http://server.srns.ru/doxygen/examples/PowerMeasure_DoxyDoc/index.html  тут].
 <div class="NavFrame collapsed">
@@ Строка 2110: / Строка 2110: @@
    </div>
 </div>
 == Ссылки ==