- update comments and documentation

pull/91/head
emirpasic 7 years ago
parent bc82528e1e
commit bd99060a93

@ -63,22 +63,22 @@ Containers are either ordered or unordered. All ordered containers provide [stat
| **Data** | **Structure** | **Ordered** | **[Iterator](#iterator)** | **[Enumerable](#enumerable)** | **Referenced by** | | **Data** | **Structure** | **Ordered** | **[Iterator](#iterator)** | **[Enumerable](#enumerable)** | **Referenced by** |
| :--- | :--- | :---: | :---: | :---: | :---: | | :--- | :--- | :---: | :---: | :---: | :---: |
| **[Lists](#lists)** | | [Lists](#lists) |
| | [ArrayList](#arraylist) | yes | yes* | yes | index | | | [ArrayList](#arraylist) | yes | yes* | yes | index |
| | [SinglyLinkedList](#singlylinkedlist) | yes | yes | yes | index | | | [SinglyLinkedList](#singlylinkedlist) | yes | yes | yes | index |
| | [DoublyLinkedList](#doublylinkedlist) | yes | yes* | yes | index | | | [DoublyLinkedList](#doublylinkedlist) | yes | yes* | yes | index |
| **[Sets](#sets)** | | [Sets](#sets) |
| | [HashSet](#hashset) | no | no | no | index | | | [HashSet](#hashset) | no | no | no | index |
| | [TreeSet](#treeset) | yes | yes* | yes | index | | | [TreeSet](#treeset) | yes | yes* | yes | index |
| | [LinkedHashSet](#linkedhashset) | yes | yes* | yes | index | | | [LinkedHashSet](#linkedhashset) | yes | yes* | yes | index |
| **[Stacks](#stacks)** | | [Stacks](#stacks) |
| | [LinkedListStack](#linkedliststack) | yes | yes | no | index | | | [LinkedListStack](#linkedliststack) | yes | yes | no | index |
| | [ArrayStack](#arraystack) | yes | yes* | no | index | | | [ArrayStack](#arraystack) | yes | yes* | no | index |
| **[Maps](#maps)** | | [Maps](#maps) |
| | [HashMap](#hashmap) | no | no | no | key | | | [HashMap](#hashmap) | no | no | no | key |
| | [TreeMap](#treemap) | yes | yes* | yes | key | | | [TreeMap](#treemap) | yes | yes* | yes | key |
| | [HashBidiMap](#hashbidimap) | no | no | no | key* | | | [HashBidiMap](#hashbidimap) | no | no | no | key* |
| **[Trees](#trees)** | | [Trees](#trees) |
| | [TreeBidiMap](#treebidimap) | yes | yes* | yes | key* | | | [TreeBidiMap](#treebidimap) | yes | yes* | yes | key* |
| | [RedBlackTree](#redblacktree) | yes | yes* | no | key | | | [RedBlackTree](#redblacktree) | yes | yes* | no | key |
| | [AVLTree](#avltree) | yes | yes* | no | key | | | [AVLTree](#avltree) | yes | yes* | no | key |

@ -2,7 +2,9 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package linkedhashset implements a set that preserves insertion-order and is backed a hash tables to store values and doubly-linked list to store ordering. // Package linkedhashset is a set that preserves insertion-order.
//
// It is backed by a hash table to store values and doubly-linked list to store ordering.
// //
// Note that insertion-order is not affected if an element is re-inserted into the set. // Note that insertion-order is not affected if an element is re-inserted into the set.
// //

Loading…
Cancel
Save