2020년 5월 26일 화요일

Doxygen 사용법

1. 기본적인 주석 형태
/**
* 기본적인 주석 형태
*/

2. 메인 페이지의 주석 
/**
* @mainpage 메인페이지의 제목을 적는다.
* @brief 간단한 설명
* @details 자세한 설명
* @section intro 소개
* @section Program 프로그램명
* @section INOUTPUT 입출력자료
* @section CREATEINFO 작성정보
* @section MODIFYINFO 수정 정보
*/

3. 각 파일에 들어갈 주석
/**
* @file hello.c
* @brief 간단한 설명
* @detail 자세한 설명
* @date 2018/1/30
*/

4. 각 함수에 대한 주석
/**
* @brief 어떤 기능을 하는 함수
* @param value 연산에 필요한 변수
* @return value 연산 결과를 반환
*/ 

5. 코드 삽입시 
@code
여기에 코드가 들어가면 된다.
@endcode

6. 버그 및 해야할 일 기록
@todo 언제까지 해야할일
@bug 값의 범위를 넘을경우 발생되는 버그가 있을 수 있다.

7. struct(class), enum
 /**  @brief buffer structor   Telnet에서 정송되는 데이터에 대해 프로토콜을 처리해야 하기 위하여,  효율적으로 데이터를 전송해야 할 입출력 버퍼 structor */ 
struct buffer{
  char *buf;   /**< 데이터를 저장할 주소공간   */         
  int size;   /**< buf에 할당된 메모리 크기   */         
  int head;   /**< buf에 저장된 데이터의 처음 Index   */
  int tail;   /**< buf에 저장된 데이터의 마지막 index */
  int count;  /**< buf에 저장된 데이터의 byte 수      */ 
}; 
 /** @brief TRUE FALSE정의. */ 
enum BOOLEAN { FALSE=0/**< FALSE */    TRUE /**< TRUE */ };

8. define, 전역 변수
#define MAX_READ_BUF   1024    /**< 최대 read buffer size      */
 short  port;                   /**< Telnet port number */ 


2020년 5월 16일 토요일

이클릅스 깃 연동

1. git서버에  폴더를 생성하고 git 초기화 해준다.
    $git init  --bare --shared

2. eclipse에서 oop C++프로젝트를 생성한다.


3. eclipse 메뉴창에서 창 -> Perspective -> Perspective 열기 -> 기타 를 선택하고, Git선택 후 열기


4. Clone a Git repository 를 선택하면 git저장소 복제 화면이 나오고 아래와 같이 설정한뒤 다음을 클릭한다.


5. Branch Selection에서 master로 체크되어있으면 다음을 클릭한다. 프로젝트의 내용이 비어있을 경우 master가 표시 되지 않을수도 있다.

6.  Local Destination의 내용은 다음과 같다.
대상 디렉토리는 이클립스에서 git서버와 연동될 폴더 지정이다.

7. 다시 C++프로젝트 퍼스펙티브로 이동하여 oop프로젝트 에서 우측 클릭을 하면 팀이 나오고 팀에서 프로젝트 공유를 선택하여 아래와 같이 설정하고 완료 한다.
Repository에서 방금 생성한 git서버를 선택


VITIS Git + Doxygen Config

 Doxygen Configure 1. Vitis 메뉴의 Window->Preference의 C/C++ -> Editor의 Documentation tool comments 기본 설정값을 Doxygen으로 변경 설정 후 함수 바로 위에서 /...