Question

我已经使用doxygen从c ++项目创建了一个乳胶文档。之后，我使用pdflatex将refman.tex文档转换为pdf（我做了几次以确保正确完成所有引用）。

我的问题是，在24个类中的2个中，构造函数没有显示我在代码中编写的简要信息和参数，而算法显示了。

我一直在寻找拼写错误，但没有发现任何错误。

这是其中一个课程的开始：

/*
 * @brief This function implements the constructor of CStatusSender class
 * @details It adds a CoreTimer Listener with STATUSSENDER_BCAST_PERIOD period 
 *  of 1000 ms to send the status packet every time the timer is called
 * @param ip: IP address of the device
 * @param version: Firmware version
 * @param ctrlp: Object of CControlProtocol class
 */
CStatusSender::CStatusSender(const char* ip, const char* version,
        CControlProtocol* ctrlp)
{

这是第二个的开始（CONTROL_PROTO_MCAST为1）。在这种情况下，创建的pdf显示了#else后面的声明，但由于CONTROL_PROTO_MCAST为1以及更重要的意义，在我的编辑器中#else部分为灰色（表示不使用该部分）： / p>

 #if CONTROL_PROTO_MCAST
/**
 * @brief This function implements the constructor of CControlProtocol class.
 * @param element_type: New value for @link m_ElementType element type @endlink 
 * @param LocalIP: New value for @link m_LocalIP local IP @endlink
 * @param rx_port: New value for @link m_RXSocket RX socket @endlink
 * @param tx_port: New value for @link m_TXSocket TX socket @endlink
 * @param rx_mcast_addr: New value for @link m_RxMcastAddr RX multicast address @endlink
 * @param tx_mcast_addrs: New value for @link m_TxMcastAddrs TX multicast address @endlink
 * @param maxLocals: New value for @link m_MaxLocalAddressNum local IP address limit @endlink
 * @param MqxThreadId: New value for Mqx thread id
 */
CControlProtocol::CControlProtocol(EElementType element_type, uint_32 LocalIP, uint_16 rx_port,
        uint_16 tx_port, uint_32 rx_mcast_addr, const std::map<EElementType, uint32_t>& tx_mcast_addrs, int maxLocals, int MqxThreadId)
#else
CControlProtocol::CControlProtocol(EElementType element_type, uint_32 LocalIP,
        uint_16 rx_port, uint_16 tx_port, uint_32 broadcast_addr, int maxLocals,
        int MqxThreadId) 
#endif
: CThreaded(MqxThreadId) {
    /**
     * @b Algorithm
     * 
     * l. Update @link m_LastTXSQ last TX SQ @endlink 
     * 2. Initialize @link m_LastRXSQTable last RX sequence table @endlink with size @link MAX_EMITTERS @endlink
     * 3. For each element of @link m_LastRXSQTable last RX sequence table @endlink do
     *     1. Element IP is 0
     *     2. Element sequence is 0
     * 4. Set @link m_LocalIP local IP @endlink parameter's value
     * 5. Set @link m_Port port @endlink parameter's value
     * 6. Set @link m_ElementType element type @endlink parameter's value
     * 7. Set @link m_bFilterRemote filter remote flag @endlink to false
     * 8. Set @link m_MaxLocalAddressNum limit local address number @endlink parameter's value
     * 9. Initialize @link m_LocalAddrs local addresses @endlink of size @link m_MaxLocalAddressNum limit local address number @endlink 
     * 10. Get @link m_RXSocket RX socket @endlink
     * 11. Get @link m_TXSocket TX socket @endlink
     * 12. CONTROL_PROTO_MCAST
     *  -# True
     *      1. Set @link m_RxMcastAddr RX multicast address @endlink parameter's value
     *      2. @link m_RxMcastAddr multicast address @endlink is a valid multicast address
     *          -# Join multicast group
     *  -# Else
     *      1. Set @link m_BroadcastAddr broadcast address @endlink parameter´s value
     * 13. Set @link m_TxMcastAddr TX multicast address @endlink parameter's value
     * 14. Initialize @link m_TXBuf TX buffer @endlink
     * 15. Initialize @link m_RXBuf RX buffer @endlink

Answer 1

也许这是一个错字，但是，您使用DECLARE @Date DATETIME = GETUTCDATE() SELECT CAST(@Date AS VARCHAR(36)); -- Dec 4 2019 11:33AM SELECT CONVERT(VARCHAR(19), @DATE, 121); -- 2019-12-04 11:33:52而不是/*开始了构造函数的文档。因此，它被解析为简单的c++注释，而不是doxygen注释。

我猜对于第二个没有显示文档的构造函数应该是相同的错误。

如果是错字，请告诉我，以便我删除此答案。

Answer 2

我已经解决了我发布的第二堂课的问题。

在Doxywizard的“专家”选项卡中，我必须转到“预处理器”，然后在其中将CONTROL_PROTO_MCAST添加到PREDEFINED。

在创建乳胶文档并将其转换为pdf之后，构造函数显示的是#if之后的一个，而不是#else之后的一个

将氧气转换为乳胶转换为pdf时出现问题

2 个答案: