From patchwork Tue Nov 15 11:37:13 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Wakely X-Patchwork-Id: 20329 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:6687:0:0:0:0:0 with SMTP id l7csp2666382wru; Tue, 15 Nov 2022 03:38:14 -0800 (PST) X-Google-Smtp-Source: AA0mqf5nAUqNqRGs1On9SihKe+LWl5GaqGBh0zqDa7ITcss5Itk/UTTK5So7xdyKVHIWY02G3of0 X-Received: by 2002:a17:906:1381:b0:7ad:bf62:e9b with SMTP id f1-20020a170906138100b007adbf620e9bmr13437600ejc.290.1668512294400; Tue, 15 Nov 2022 03:38:14 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1668512294; cv=none; d=google.com; s=arc-20160816; b=UKUDfHP7koUX3oQhyuWTZ05Q7hA/IjHNkVrVD8D/SfxcfnU2idkZyiCsY71jtJe16w iyHqQsBf+pKr9MmV7vnDQXcxDQIKGNc15au5gNxRmHj2Oe8VZbhvZS61fs+f/uXcKtRj KXwdbL8NNopCDZDbrgagPLKzDW1qhCJ6kat2ZCqiZ6DuvMyT9LUkTEezTJvSVU7Gb5VO Nqlc+LEaSubBfpnunOuXO0ac53JiM5c6iNdoDDxS24rk4u9LQ8BaYhFQzS2MYisJjrYF MdNktlOL3R2mxO4T/n6o1kv9Jj5UIEgVFrrDxFTrDMrON3MLeU6FHlp00zW1tZT5ZnJf jwPg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:reply-to:from:list-subscribe:list-help:list-post :list-archive:list-unsubscribe:list-id:precedence :content-transfer-encoding:mime-version:message-id:date:subject:to :dmarc-filter:delivered-to:dkim-signature:dkim-filter; bh=N3TzP0PjyTKM32N3UFtdB4APXChiqya+vnPtGENB6yg=; b=F+C4W+cAcq/y7bZxycQZLQmsTP7xdLZGP0oBwHgkdg1oppmXyzLFj7vctqksXg48bH GC8nIONW/RU01MiFpPysFdLTCyDmiDfmyDvu58pAiiLNHNEiJksrLRcqZyrpPLjJpg4t 5aYaEztQ7FQDhthrAGfn9311L5sSAKGk8i2AaFphp4p1JGCy6ByOYg7O/4m9TZ/1x6yW 03wNbFm0un+Tlx8evQc8qsFRjKpVLYVwz1tV+bw/cczIl4+exNBphpfBFBh1CaZzq4JV Ekx+tdpfSoz+pkrVAJ4UdDAeXnoIbXVOSvnTE6ga3WGpp9ZZHwMuYeQJykhikUzAiR5V ZjTg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gcc.gnu.org header.s=default header.b=OGxV94kq; spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gnu.org Received: from sourceware.org (server2.sourceware.org. [8.43.85.97]) by mx.google.com with ESMTPS id cs14-20020a0564020c4e00b00462e4cbe815si12045638edb.550.2022.11.15.03.38.14 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Nov 2022 03:38:14 -0800 (PST) Received-SPF: pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) client-ip=8.43.85.97; Authentication-Results: mx.google.com; dkim=pass header.i=@gcc.gnu.org header.s=default header.b=OGxV94kq; spf=pass (google.com: domain of gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org designates 8.43.85.97 as permitted sender) smtp.mailfrom="gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gnu.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 5CDEF388E81A for ; Tue, 15 Nov 2022 11:38:04 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 5CDEF388E81A DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gcc.gnu.org; s=default; t=1668512284; bh=N3TzP0PjyTKM32N3UFtdB4APXChiqya+vnPtGENB6yg=; h=To:Subject:Date:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=OGxV94kqrOGZSpQIAS/4H5bm3C2u0DW8L/DKmn2dpRGX8NMGC3cO2GBvrUhhd1LQ6 QkcNThUcl3xkW37MnAnBlHnZVnd6LtJqMFIjDca2ggB5wV8J4S2tlv3+t8zvZre8Uv TlPMb00h+F2nZDRt+T9KPd0jKMiQEnOAgTL7fWD8= X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id A44D13888C79 for ; Tue, 15 Nov 2022 11:37:20 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org A44D13888C79 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-292-DJjwMdIlO6qf17olEBZ9kA-1; Tue, 15 Nov 2022 06:37:16 -0500 X-MC-Unique: DJjwMdIlO6qf17olEBZ9kA-1 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 8DA57811E75; Tue, 15 Nov 2022 11:37:16 +0000 (UTC) Received: from localhost (unknown [10.33.36.199]) by smtp.corp.redhat.com (Postfix) with ESMTP id 56C66492B05; Tue, 15 Nov 2022 11:37:16 +0000 (UTC) To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org Subject: [committed] libstdc++: Document use of Markdown for Doxygen comments Date: Tue, 15 Nov 2022 11:37:13 +0000 Message-Id: <20221115113713.1131991-1-jwakely@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-11.8 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_NONE, SPF_NONE, TXREP autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Jonathan Wakely via Gcc-patches From: Jonathan Wakely Reply-To: Jonathan Wakely Errors-To: gcc-patches-bounces+ouuuleilei=gmail.com@gcc.gnu.org Sender: "Gcc-patches" X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1749561947146055899?= X-GMAIL-MSGID: =?utf-8?q?1749561947146055899?= Pushed to trunk. -- >8 -- libstdc++-v3/ChangeLog: * doc/xml/manual/documentation_hacking.xml: Document use of Markdown for Doxygen comments. Tweak formatting. * doc/html/manual/documentation_hacking.html: Regenerate. --- .../html/manual/documentation_hacking.html | 21 ++++++++------ .../doc/xml/manual/documentation_hacking.xml | 28 ++++++++++++++----- 2 files changed, 34 insertions(+), 15 deletions(-) diff --git a/libstdc++-v3/doc/xml/manual/documentation_hacking.xml b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml index 776d5e857b5..44672f6e26d 100644 --- a/libstdc++-v3/doc/xml/manual/documentation_hacking.xml +++ b/libstdc++-v3/doc/xml/manual/documentation_hacking.xml @@ -286,7 +286,9 @@ formatting system, and will require the expansion of TeX's memory capacity. Specifically, the pool_size variable in the configuration file texmf.cnf may - need to be increased by a minimum factor of two. + need to be increased by a minimum factor of two. Alternatively, using + LATEX_CMD=lualatex might allow the docs to be + build without running out of memory. @@ -515,9 +517,12 @@ - Please use markup tags like @p and @a when referring to things - such as the names of function parameters. Use @e for emphasis - when necessary. Use @c to refer to other standard names. + Markdown can be used for formatting text. Doxygen is configured to + support this, and it is a good compromise between readable comments + in the C++ source and nice formatting in the generated HTML. + Please format the names of function parameters in either code font + or italics. Use underscores or @e for emphasis when necessary. + Use backticks or @c to refer to other standard names. (Examples of all these abound in the present code.) @@ -595,6 +600,7 @@ HTML Doxygen + Markdown @@ -602,41 +608,49 @@ \ \\ + \\ " \" + \" ' \' + \' <i> @a word + _word_ or *word* <b> @b word + **word** or __word__ <code> @c word + `word` <em> @a word + _word_ or *word* <em> <em>two words or more</em> + _two words or more_ @@ -719,7 +733,7 @@ - Editing the DocBook sources requires an XML editor. Many + An XML editor is recommended for editing the DocBook sources. Many exist: some notable options include emacs, Kate, or Conglomerate. @@ -815,8 +829,8 @@ - The doc-html-docbook-regenerate target will generate - the HTML files and copy them back to the libstdc++ source tree. + The doc-html-docbook-regenerate target will + generate the HTML files and copy them back to the libstdc++ source tree. This can be used to update the HTML files that are checked in to version control.