From f97bce5f91383ffb36ab1d54d0f5afcc2cfbba11 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Wed, 9 Sep 2020 15:50:43 -0600 Subject: [PATCH] Properly reference Code Complete. --- doc/doxygen/references.bib | 9 +++++++++ examples/step-1/doc/intro.dox | 2 +- examples/step-26/step-26.cc | 8 ++++---- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/doc/doxygen/references.bib b/doc/doxygen/references.bib index 1955584265..99dd409194 100644 --- a/doc/doxygen/references.bib +++ b/doc/doxygen/references.bib @@ -907,3 +907,12 @@ year = {2008}, year = {2001}, doi = {10.1023/A:1014268310921} } + + + +@Book{CodeComplete, + author = {Steve McConnell}, + title = {Code Complete}, + publisher = {Microsoft Press}, + year = 2004, + edition = {second}} diff --git a/examples/step-1/doc/intro.dox b/examples/step-1/doc/intro.dox index 3a78ecedbb..bc704d07a9 100644 --- a/examples/step-1/doc/intro.dox +++ b/examples/step-1/doc/intro.dox @@ -188,7 +188,7 @@ are worthwhile browsing through before you start any large-scale programming: - You will benefit from becoming a better programmer. An excellent resource to this end is the book "Code - Complete" by Steve McConnell (ISBN 978-0735619678). It's already + Complete" by Steve McConnell @code CodeComplete . It's already a few years old, with the last edition published in 2004, but it has lost none of its appeal as a guide to good programming practices, and some of the principal developers use it as a group reading diff --git a/examples/step-26/step-26.cc b/examples/step-26/step-26.cc index df150e3d40..2f9e2ed363 100644 --- a/examples/step-26/step-26.cc +++ b/examples/step-26/step-26.cc @@ -648,10 +648,10 @@ namespace Step26 // state that there may be occasions where they can help avoid code // duplication and awkward control flow. This may be one of these // places, and it matches the position Steve McConnell takes in his -// excellent book "Code Complete" about good programming practices -// (see the mention of this book in the introduction of step-1) that -// spends a surprising ten pages on the question of goto -// in general. +// excellent book "Code Complete" @cite CodeComplete about good +// programming practices (see the mention of this book in the +// introduction of step-1) that spends a surprising ten pages on the +// question of goto in general. // @sect3{The main function} -- 2.39.5