Skip to content

Commit 328fbf6

Browse files
Merge pull request #41 from EricCousineau-TRI/feature-deprecated
cppguide: Clarify use of DRAKE_DEPRECATED
2 parents d61cc1d + a5346af commit 328fbf6

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

cppguide.html

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5407,12 +5407,25 @@ <h3 id="TODO_Comments">TODO Comments</h3>
54075407

54085408
<h3 id="Deprecation_Comments">Deprecation Comments</h3>
54095409

5410-
<div class="summary">
5410+
<div class="drake">
5411+
<p>Deprecated interfaces should use the
5412+
<a href="https://drake.mit.edu/doxygen_cxx/drake__deprecated_8h.html">
5413+
<code>DRAKE_DEPRECATED</code></a> macro (refer to its API documentation for
5414+
more information). If you wish to see prior usages of the macro, you can use
5415+
the following <code>git</code> query to see commits that add or remove usage of
5416+
the string:</p>
5417+
<pre>
5418+
cd drake
5419+
git log -S DRAKE_DEPRECATED
5420+
</pre>
5421+
</div>
5422+
5423+
<div class="summary nondrake">
54115424
<p>Mark deprecated interface points with <code>DEPRECATED</code>
54125425
comments.</p>
54135426
</div>
54145427

5415-
<div class="stylebody">
5428+
<div class="stylebody nondrake">
54165429

54175430
<p>You can mark an interface as deprecated by writing a
54185431
comment containing the word <code>DEPRECATED</code> in

0 commit comments

Comments
 (0)