Book a Demo

Author Topic: Synchronizing class "Note" field w/header comments  (Read 2921 times)

tbulik

  • EA Novice
  • *
  • Posts: 1
  • Karma: +0/-0
    • View Profile
Synchronizing class "Note" field w/header comments
« on: February 07, 2003, 11:32:15 am »
Greetings,

I tend to do allot of reverse engineering of code. My company has a standard class header file format that contains a description of the class at the top of the file. It looks something like this:

// -----------------------------------------------------------------------
//
//  @$Id: Template.h,v 1.1.1.1 2003/01/30 03:01:09 tony Exp $
//
//  @Copyright: (C) 2002 MYCOMPANY, Inc, all rights reserved.
//  Software and information contained herein is confidential and
//  proprietary to MYCOMPANY. Any unauthorized copying, dissemination,
//  or use is strictly prohibited.
//
//  @Author: I. M. Coder
//
//  @Description: [DESCRIBE OF WHAT THIS CLASS/MODULE DOES HERE]
//
//  @Non Portable Features: [DESCRIBE NON-PORTABLE FEATURES IN THE API]
//
//  @Assumptions: [ASSUMPTIONS IN THE API]
//
//  @Notes: I want these comments to be associated with
//  the EA class "Note" field.

//
//  @History: See end of file for history log.
//
// -----------------------------------------------------------------------
// *INDENT-OFF*
#ifndef Template_H
#define Template_H

// These comments are what currently get associated with "Note"
class Template
{
   o
   o
   o
}

#endif

EA seems to only put comments that immediately preceed the "class" keyword into the "Note" field. I would like comments that occur farther up in my header file (specifically those the follow the "@Notes" comment above, to be placed in the EA class "Note" field. Is there any way to tell EA to look elsewhere for notes?

It wouldn't be a big deal, but I use the automatic documentation generation feature and the generated documentation never has any descriptions for my classes. Cutting from the code and pasting into the EA diaglog is too tedious and it gets wacked when I reverse engineer anyway.

Thanks,
D. Tony Bulik

« Last Edit: February 07, 2003, 11:52:04 am by tbulik »