From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: 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 D09A53889E09 for ; Tue, 15 Nov 2022 11:37:18 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org D09A53889E09 Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1668512238; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=N3TzP0PjyTKM32N3UFtdB4APXChiqya+vnPtGENB6yg=; b=A9KnGPYl5u9Nrpvybfpv6pdc+8M8gXhsmMa7DwkIzTV8CLFGoTVsAT06RqrXlF/n2juK5E tCuT9P4VfYUPPwSoFXoHbrLY65kXKEgX/vB6wBXSJ1h87UeWmGD808EB6JdRSG96x+dn9M aRqQT8hfEd9W1wIs6KEkDRSegfPpMSk= 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) From: Jonathan Wakely 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 Content-Type: text/plain Content-Transfer-Encoding: 8bit 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=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: 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. -- 2.38.1