@override
=============================

.. rst:directive:: @override

   :Syntax: ``@override``
   :Overview:

      The :rst:dir:`@override` tag indicates that a symbol overrides a symbol with
      the same name in a parent class.

      This tag is provided for compatibility with `Closure Compiler <https://developers.google.com/closure/compiler/>`_.
      By default, JSDoc automatically identifies symbols that override a parent.

      If your JSDoc comment includes the :rst:dir:`@inheritdoc`, you do not need to include the
      :rst:dir:`@override` tag. The presence of the :rst:dir:`@inheritdoc` tag implies the
      presence of the :rst:dir:`@override` tag.

   :Example:

      The following example shows how to indicate that a method overrides a
      method in its parent class:

      .. code-block:: js
         :caption: Method that overrides a parent

         /**
          * @classdesc Abstract class representing a network connection.
          * @class
          */
         function Connection() {}

         /**
          * Open the connection.
          */
         Connection.prototype.open = function() {
             // ...
         };


         /**
          * @classdesc Class representing a socket connection.
          * @class
          * @augments Connection
          */
         function Socket() {}

         /**
          * Open the socket.
          * @override
          */
         Socket.prototype.open = function() {
             // ...
         };