블로그 이미지
Every unexpected event is a path to learning for you.

카테고리

분류 전체보기 (2328)N
Unity3D (572)N
Programming (472)
Unreal (4)
Gamebryo (56)
Tip & Tech (185)
협업 (34)
3DS Max (3)
Game (12)
Utility (116)
Etc (92)
Link (31)
Portfolio (19)
Subject (90)
iOS,OSX (38)
Android (13)
Linux (5)
잉여 프로젝트 (2)
게임이야기 (1)
Memories (19)
Interest (37)
Thinking (36)
한글 (26)
PaperCraft (5)
Animation (408)
Wallpaper (2)
재테크 (19)
Exercise (3)
나만의 맛집 (2)
냥이 (9)
육아 (9)
Total1,346,328
Today134
Yesterday132
Statistics Graph

달력

« » 2019.12
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30 31        

공지사항

태그목록

'doxygen'에 해당되는 글 3건

  1. 2014.09.11 Doxygen For Unity
  2. 2012.06.12 [삽질] KingsTools 함수등 정보가 안보일 때..
  3. 2011.06.17 자주쓰는 DoxyGen 주석

Doxygen For Unity

Unity3D/Tips / 2014. 9. 11. 10:18



DoxygenForUnity.zip




Link : http://www.jacobpennock.com/Blog/?p=629

Posted by blueasa

댓글을 달아 주세요

프로그램 : VS2008, KingsTools2008(Doxygen 1.5.0)


[문제점] KingsTools2008로 문서화를 하기 위해서 뽑아봤는데 함수에 달린 주석이 안나왔다.


이리저리 뒤지다 보니 힌트가 될만한 아래와 같은 내용을 찾았다.

  • 아무런 설정 없이 doxygen 문서를 만들면 private이나 protected 함수는 doxygen에 나타나지 않는다. 이러한 것들을 모두 doxygen 문서에 나타내고 싶은 경우
  • DoxyWizard의 "Expert"의 "Build" 탭에서 EXTRACT_로 시작하는 부분을 체크해주면 된다. "EXTRACT_PRIVATE"을 클릭하면 private 함수들이 보여지는 식이다. 

그래서 doxywizard로 가서 해보려 했지만.. 여기서 셋팅한다고 KingsTools 셋팅에 영향을 주진 않는다는 걸 알았을 뿐..

그래서 좀 더 찾다보니..

'Run Doxygen..'을 실행시킨 프로젝트 안에 Doxyfile.cfg 라는 파일이 생성된 걸 알았다.

오잉? 하고 열어보니 doxywizard-Build와 같은 내용의 설정 옵션들이 있었다.
그리고 내용은 대략 아래와 같았다.(중요한 부분만..)

OUTPUT_DIRECTORY = Doc
EXTRACT_ALL = NO
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
...하략...

KingsTools에서 EXTRACT_ALL을 YES로 만들려면 어디를 만져야 되는지 모르겠다.
(아시는  분 리플좀..굽실굽실..)

그래서 수동으로 EXTRACT_ALL = YES로 만들고 저장..

다시 Run Doxygen..을 하니 원하던 함수에 달아놓은 주석 정보와 함께 모든 정보가 잘 뽑혀 나온다.

실제 옵션에서 셋팅하는 방법을 알게되기 전까진 수고스럽지만 이방법으로 해야겠다..

'Utility > Doxygen' 카테고리의 다른 글

[삽질] KingsTools 함수등 정보가 안보일 때..  (0) 2012.06.12
자주쓰는 DoxyGen 주석  (0) 2011.06.17
KingsTools VS2008 버전  (0) 2011.01.21
Posted by blueasa

댓글을 달아 주세요

 
KinsgTool을 쓰면서 자주 쓰는 DoxyGen 주석을 적어논다.
쓰다보면 더 늘어날것도 같지만 우선 아래 몇가지는 종종 쓸거 같다.
필요할경우 적절히 수정해서 사용하면 된다.

Mainpage 설명용

/**

* \mainpage

KingsTool 사용 예제

* \section intro

소개

* : Kingstool을 사용하는 방법

* \section Program

프로그램 설명

* : KingsTool로 문서화 되는 모습을 보이기위한 간단한 프로그램

* \section CREATEINFO

작성정보

* 만든이 : ItsMe \n

* 작성일 : 2008-09-09

* \section MODIFYINFO

수정내역

* 수정자 / 수정일 : 수정내역등 \n

* ItsMe / 08.09.09 : KingsTool 사용방법 테스트 클래스 추가

*/

파일목록을 만들시
(
파일 상단에 위치시킨다.)

/**

* \file Animal.h

* \date 2008/9/9

* \author ItsMe

* \brief 테스트일겁니다.

*/

Class에 사용시
(
클래스 상단에 사용)


/**
* \date 2008-09-09
* \author ItsMe
* \brief
강아지에 대하여 나타내는 Class
*/
class CDog : public CAnimal

함수에 사용시
(
함수 상단에 사용)


/**

* \param 설정할 강아지타입
* \return
성공여부

*/
///
강아지 종류 설정bool SetDogType(int iSetDogType){

enum을 나타낼시
(
위치는 아무데나 상관없으나,
파일목록을 만드는주석 밑에 위치하는게 보기에 편할 듯 싶다.)


/**
* \enum CDog::DogType
* \brief enum
설명
*/

Enum 세부주석


class CDog : public CAnimal{
enum {
DOGTYPE_BEAGLE = 0, ///<
종류 : 비글



'Utility > Doxygen' 카테고리의 다른 글

[삽질] KingsTools 함수등 정보가 안보일 때..  (0) 2012.06.12
자주쓰는 DoxyGen 주석  (0) 2011.06.17
KingsTools VS2008 버전  (0) 2011.01.21
Posted by blueasa

댓글을 달아 주세요