add doc to image media component

allyoucanmap · allyoucanmap · commit 0984bbc27c6e · 2019-08-02T18:00:14.000+02:00
diff --git a/web/client/components/geostory/media/Image.jsx b/web/client/components/geostory/media/Image.jsx
@@ -11,6 +11,15 @@ import Lightbox from 'react-image-lightbox';
 import objectFitImages from 'object-fit-images';
 import { withState } from 'recompose';
 
+/**
+ * Image media component
+ * @class
+ * @name Image
+ * @prop {string} src source of the image
+ * @prop {string} fit one of 'cover' or 'contain'
+ * @prop {boolean} enableFullscreen enable fullscreen preview with pan and zoom options
+ */
+
 class Image extends Component {
 
     static propTypes = {
