Doxygen and typedefs inside namespaces

时光怂恿深爱的人放手 提交于 2020-01-15 06:18:08

问题


Could someone tell me what is wrong with this code so doxygen cannot handle?

/*!
\file   Enumerator.h
\brief  Implements an Enumerator pointer for accessing linked list elements.
*/

#pragma once

#ifndef __MSCL_ENUMERATOR_H__
#define __MSCL_ENUMERATOR_H__

namespace MSCL 
{

/*!
\typedef Enumerator

Pointer to linked list data structure.

\sa ArrayList::GetEnumerator, \sa List::GetEnumerator
*/
typedef void* Enumerator;

};
#endif

I need the Enumerator that is used by many methods as an argument type to be

1) Visible in the help index.

2) Correctly linked with this documentation page.

Target documentation format is chm.

It's absolutely confusing becuase there's no error, no warning, nothing.

Once, after playing with different doxygen configuration options I managed to achieve #1 - the type was in the index but I have no idea what switch did that and I couldn't repeat it.


回答1:


If I add a doxygen comment to describe namespace MSCL, then documentation for MSCL::Enumerator is generated properly.



来源:https://stackoverflow.com/questions/1290406/doxygen-and-typedefs-inside-namespaces

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!