PSoC Creator 4.2: Emulated EEPROM component creates an unwanted Doxygen mainpage

Tip / Sign in to post questions, reply, level up, and achieve exciting badges. Know more

cross mob
JoKe_1629696
Level 1
Level 1

Is there a way to prevent the Emulated EEPROM component API from generating a Doxygen mainpage?  This page, while interesting, is not the first thing I want readers of my documentation to see.  Here is the offending code, from the generated file cy_em_eeprom.h:

/*******************************************************************************

* \file cy_em_eeprom.h

* \version 2.0

*

* \brief

*  This file provides the function prototypes and constants for the Emulated

*  EEPROM middleware library.

*

********************************************************************************

* Copyright 2017, Cypress Semiconductor Corporation.  All rights reserved.

* You may use this file only in accordance with the license, terms, conditions,

* disclaimers, and limitations in the end user license agreement accompanying

* the software package with which this file was provided.

*******************************************************************************/

/**

* \mainpage Cypress Em_EEPROM Middleware Library

*

* The Emulated EEPROM provides an API that allows creating an emulated

* EEPROM in flash that has the ability to do wear leveling and restore

* corrupted data from a redundant copy. The Emulated EEPROM library is designed

* to be used with the Em_EEPROM component.

...

0 Likes
1 Solution

It wasn't the content I wanted removed--just the 'mainpage' tag.  Anyway, I found a way using the Pre Build user command:

Pre Build.png

The perl one-liner is

perl -p -i.bak -e "s/\\mainpage/\\page/" Generated_Source\PSoC4\cy_em_eeprom.h

View solution in original post

0 Likes
2 Replies
AnkitaS_51
Employee
Employee
100 likes received 50 likes received 25 likes received

Hello Joseph,

The definition of EEPROM APIs is contained in cy_em_eeprom.h or.c file.This main page content(mainly the Copyright stuff ) mentioned in cy_em_eeprom.h or.c cannot be removed .

0 Likes

It wasn't the content I wanted removed--just the 'mainpage' tag.  Anyway, I found a way using the Pre Build user command:

Pre Build.png

The perl one-liner is

perl -p -i.bak -e "s/\\mainpage/\\page/" Generated_Source\PSoC4\cy_em_eeprom.h

0 Likes