From patchwork Thu Mar 13 06:13:24 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yao Qi X-Patchwork-Id: 63 Return-Path: X-Original-To: siddhesh@wilcox.dreamhost.com Delivered-To: siddhesh@wilcox.dreamhost.com Received: from homiemail-mx22.g.dreamhost.com (caibbdcaabij.dreamhost.com [208.113.200.189]) by wilcox.dreamhost.com (Postfix) with ESMTP id 5D92C360158 for ; Wed, 12 Mar 2014 23:16:06 -0700 (PDT) Received: by homiemail-mx22.g.dreamhost.com (Postfix, from userid 14314964) id 17FD84DAF9DB; Wed, 12 Mar 2014 23:16:06 -0700 (PDT) X-Original-To: gdb@patchwork.siddhesh.in Delivered-To: x14314964@homiemail-mx22.g.dreamhost.com Received: from sourceware.org (server1.sourceware.org [209.132.180.131]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by homiemail-mx22.g.dreamhost.com (Postfix) with ESMTPS id DED304DAF96F for ; Wed, 12 Mar 2014 23:16:05 -0700 (PDT) DomainKey-Signature: a=rsa-sha1; c=nofws; d=sourceware.org; h=list-id :list-unsubscribe:list-subscribe:list-archive:list-post :list-help:sender:from:to:subject:date:message-id:mime-version :content-type; q=dns; s=default; b=WOmKEohyLZieN0tBt0TheewJRhhAq 5LA3tC2PNVoqkHIfRBDsHx6Yw7zPYF7ipej9rv327HAxErZJhrn4Efa38PwoJIGa m64PD6fK1Fvp/tTHIwPZPgfkCv2yBoHef0tqQJa1XFR894BXistoT6DCd9G13RTK mvYZW7V9sDGw2k= DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=sourceware.org; h=list-id :list-unsubscribe:list-subscribe:list-archive:list-post :list-help:sender:from:to:subject:date:message-id:mime-version :content-type; s=default; bh=NC3xpe+4hsyCmqAaH3c0F5IFGWg=; b=nIh 4Vt+iL3+FnYIumVwIfm1sPMJnGmitDfbVgxqSWaCma1OEZeJN3GhleghOqABCf3s PW0RHMgfKBLKvKn2p0eKOhb0ZMVCwoULbOttUR/LQ/5Trb0vfcdxkDVjAcKAXbWR xMNqb7Uk9UTwjWOJ5e22w7b4s2+YESCOg1CCZ7IM= Received: (qmail 21563 invoked by alias); 13 Mar 2014 06:16:03 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 21548 invoked by uid 89); 13 Mar 2014 06:16:02 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.6 required=5.0 tests=AWL, BAYES_00 autolearn=ham version=3.3.2 X-HELO: relay1.mentorg.com Received: from relay1.mentorg.com (HELO relay1.mentorg.com) (192.94.38.131) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 13 Mar 2014 06:16:00 +0000 Received: from svr-orw-fem-01.mgc.mentorg.com ([147.34.98.93]) by relay1.mentorg.com with esmtp id 1WNyvs-00059r-Bk from Yao_Qi@mentor.com for gdb-patches@sourceware.org; Wed, 12 Mar 2014 23:15:56 -0700 Received: from SVR-ORW-FEM-03.mgc.mentorg.com ([147.34.97.39]) by svr-orw-fem-01.mgc.mentorg.com over TLS secured channel with Microsoft SMTPSVC(6.0.3790.4675); Wed, 12 Mar 2014 23:15:56 -0700 Received: from qiyao.dyndns.org.com (147.34.91.1) by svr-orw-fem-03.mgc.mentorg.com (147.34.97.39) with Microsoft SMTP Server id 14.2.247.3; Wed, 12 Mar 2014 23:15:55 -0700 From: Yao Qi To: Subject: [PATCH] Automatic link generation by doxygen Date: Thu, 13 Mar 2014 14:13:24 +0800 Message-ID: <1394691204-10899-1-git-send-email-yao@codesourcery.com> MIME-Version: 1.0 X-IsSubscribed: yes X-DH-Original-To: gdb@patchwork.siddhesh.in Nowadays, we have one page on "GDB Types" generated by doxygen, but types and macros referenced in doc are not linked to their definitions. This patch tweaks the comments a little to use doxygen syntax so that these types and macros are linked their definitions. Is it OK? gdb: 2014-03-13 Yao Qi * gdbtypes.h: Update comments to link to types and macros' definitions. --- gdb/gdbtypes.h | 15 ++++++++------- 1 files changed, 8 insertions(+), 7 deletions(-) diff --git a/gdb/gdbtypes.h b/gdb/gdbtypes.h index c6943ef..9c9423e 100644 --- a/gdb/gdbtypes.h +++ b/gdb/gdbtypes.h @@ -28,18 +28,19 @@ languages using a common representation defined in gdbtypes.h. The main data structure is main_type; it consists of a code (such - as TYPE_CODE_ENUM for enumeration types), a number of + as #TYPE_CODE_ENUM for enumeration types), a number of generally-useful fields such as the printable name, and finally a - field type_specific that is a union of info specific to particular - languages or other special cases (such as calling convention). + field main_type::type_specific that is a union of info specific to + particular languages or other special cases (such as calling + convention). - The available type codes are defined in enum type_code. The enum + The available type codes are defined in enum #type_code. The enum includes codes both for types that are common across a variety of languages, and for types that are language-specific. - Most accesses to type fields go through macros such as TYPE_CODE - and TYPE_FN_FIELD_CONST. These are written such that they can be - used as both rvalues and lvalues. + Most accesses to type fields go through macros such as + #TYPE_CODE(thistype) and #TYPE_FN_FIELD_CONST(thisfn, n). These are + written such that they can be used as both rvalues and lvalues. */ #include "hashtab.h"