Commit 0d56aa30 authored by Loïck Bonniot's avatar Loïck Bonniot

[doc] Add synopsis to packages

parent 57c38b3f
Pipeline #1098 passed with stages
// Package cmd handles flags and commands management.
package cmd
import (
......
// Package common Holds the common function to be used by other package
// Essentially handles I/O functions
// Package common holds the common functions to be used by other packages.
package common
import (
......
// Package dfssc is the dfss CLI client.
package main
import (
......
// Package sign handles contract and signature operations.
package sign
import (
......
// Package cmd handles flags and commands management.
package cmd
import (
......
// Package dfssd is the dfss demonstrator.
package main
import (
......
// Package server provides the demonstration unsecure server.
package server
import (
......
// Package authority creates and manages platform certificates.
package authority
import (
......
// Package cmd handles flags and commands management.
package cmd
import (
......
// Package common provides non-specific helpers, such as parallelism management.
package common
import (
......
// Package contract manages contracts and signatures (creation and execution).
package contract
import (
......
// Package entities contains database entities and helpers on these entities.
package entities
import (
......
// Package dfssp is the dfss platform.
package main
import (
......
// Package server provides the platform server.
package server
import (
......
// Package templates stores and provides basic templates for mails or CLI.
package templates
import (
......
// Package user handles user creation.
package user
import (
......@@ -9,8 +10,6 @@ import (
"log"
"time"
"github.com/spf13/viper"
"dfss/auth"
"dfss/dfssp/api"
"dfss/dfssp/authority"
......@@ -18,7 +17,7 @@ import (
"dfss/dfssp/entities"
"dfss/dfssp/templates"
"dfss/mgdb"
"github.com/spf13/viper"
"gopkg.in/mgo.v2/bson"
)
......
// Package cmd handles flags and commands management.
package cmd
import (
......
// Package entities contains database entities and helpers on these entities.
package entities
import (
......
// Package dfsst is the dfss trusted third-party (ttp).
package main
import (
......
// Package resolve provides the resolve protocol.
package resolve
import (
......
// Package server provides the ttp server.
package server
import (
......
// Package authform provides the authentication screen.
package authform
import (
......
// Package common provides GUI helpers, such as dialog boxes.
package common
// This file handles basic feedback messages.
......
// Package contractform provides the new contract screen.
package contractform
import (
......
// Package gui is the dfss GUI client.
package main
import (
......
// Package showcontract provides the show contract screen.
package showcontract
import (
......
// Package signform provides the signature screen.
package signform
import (
......
// Package userform provides the new user screen.
package userform
import (
......
// Package welcome provides the home screen for authenticated users.
package welcome
import (
......
// Package mgdb simplifies the mapping between Go and Mgo.
package mgdb
import (
......
// Package net wraps TLS and GRPC client/server to simplify connections.
package net
import (
......
// Package tests provides DFSS integration tests.
package tests
// A test package, see test files.
// Package dfss is the root of the dfss architecture.
package dfss
import (
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment