Documenting #79

Рефакторинг классов ERIonGenerators, ERIonMixGenerator, классы BeamDet

Added by Vitaliy Schetinin over 6 years ago. Updated about 6 years ago.

Status:ЗакрытаStart date:10/11/2017
Priority:НизкийDue date:
Assignee:Mikhail Kozlov% Done:

100%

Category:BeamDet
Target version:v-1.0

Description

Необходимо привести классы в соответствие с code convention: http://er.jinr.ru/dev.html#id4

Особое внимание обратить на doxygen комментарии интерфейсов.

Для локальной генерации doxygen использовать: doxygen Doxyfile

History

#1 Updated by Mikhail Kozlov over 6 years ago

В code convention не сказано об описании методов в заголовочном файле (например в ERIonGenerator).
Можно ли их описывать прямо там, если да, то в каком стиле?

#2 Updated by Vitaliy Schetinin over 6 years ago

В хедере стоит писать только легковесные функции типа get и set. Прямо в объявлении класса. То есть мы подразумеваем что они встраиваемые, а не вызыавемые. Дополнительно слово inline писать не надо, всё и так понятно. Вне объявления класса опредления методов в хедере быть не должно.

Я занесу это в конвенци. Спасибо, что обратил внимание.

#3 Updated by Vitaliy Schetinin over 6 years ago

Пока комментарии к этой ветке такие:

1) Круто, что уже получилось сделать ERBeamDet, ERIonGenerator, ERIonMixGenerator.

Я их вкинул в dev, потому что пользователям очень нужна документация.

http://er.jinr.ru/doxygen/class_e_r_beam_det.html

http://er.jinr.ru/doxygen/class_e_r_ion_generator.html

2) Ветка не компилиться) История про TOF и ToF не доделана до конца. Нужно поправить как можно скорее.

#4 Updated by Mikhail Kozlov over 6 years ago

Поправил ошибки компиляции.

Нужно ли в doxygen вносить комментарии приватных членов класса?

#5 Updated by Sergey Belogurov over 6 years ago

Можно ли сделать линк на документацию FAIRroot?  Это было бы полезно. В идеале от  клетки, соответствующей каждому классу, или хотя бы поместить общую ссылку в удобном месте, чтобы юзер, читая нашу документацию, мог легко перейти на описание родительских классов. Миша говорит, какая-то версия документации fairroot была, да отвалилась.  Если так, Виталтик, запросите , пожалуйста, Радека, куда смотреть. 

#6 Updated by Vitaliy Schetinin about 6 years ago

Влито в dev

#7 Updated by Vitaliy Schetinin about 6 years ago

  • Status changed from Открыта to Закрыта
  • Target version changed from v-0.4 to v-1.0
  • % Done changed from 0 to 100

Also available in: Atom PDF